From cbd50c68fadde3814f18b60732624be08e8e1cef Mon Sep 17 00:00:00 2001 From: John Peterson <98187317+John-peterson-coinbase@users.noreply.github.com> Date: Tue, 30 Jul 2024 11:31:37 -0400 Subject: [PATCH] V0.0.13 Release (#121) * carry forward comments in compiled js code * [PSDK-348] support trades with server signer (#119) * [PSDK-348] Trade Verb Support w/ MPC Server-Signer * jazz review feedback * [chore] Prepare 0.0.13 Release --------- Co-authored-by: Rohit Durvasula <rohit.durvasula@coinbase.com> Co-authored-by: Rohit Durvasula <88731568+drohit-cb@users.noreply.github.com> --- CHANGELOG.md | 9 + README.md | 4 +- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/client_api.AddressesApi.html | 16 +- docs/classes/client_api.AssetsApi.html | 6 +- .../client_api.ExternalAddressesApi.html | 10 +- docs/classes/client_api.ServerSignersApi.html | 16 +- docs/classes/client_api.StakeApi.html | 12 +- docs/classes/client_api.TradesApi.html | 12 +- docs/classes/client_api.TransfersApi.html | 12 +- docs/classes/client_api.UsersApi.html | 6 +- docs/classes/client_api.ValidatorsApi.html | 8 +- docs/classes/client_api.WalletsApi.html | 14 +- docs/classes/client_base.BaseAPI.html | 4 +- docs/classes/client_base.RequiredError.html | 4 +- .../client_configuration.Configuration.html | 22 +-- docs/classes/coinbase_address.Address.html | 16 +- ...ress_external_address.ExternalAddress.html | 42 ++--- ..._address_wallet_address.WalletAddress.html | 47 +++-- docs/classes/coinbase_api_error.APIError.html | 8 +- ...coinbase_api_error.AlreadyExistsError.html | 8 +- ...ase_api_error.FaucetLimitReachedError.html | 8 +- ...oinbase_api_error.InvalidAddressError.html | 8 +- ...nbase_api_error.InvalidAddressIDError.html | 8 +- ...coinbase_api_error.InvalidAmountError.html | 8 +- ...oinbase_api_error.InvalidAssetIDError.html | 8 +- ...ase_api_error.InvalidDestinationError.html | 8 +- .../coinbase_api_error.InvalidLimitError.html | 8 +- ...nbase_api_error.InvalidNetworkIDError.html | 8 +- .../coinbase_api_error.InvalidPageError.html | 8 +- ...e_api_error.InvalidSignedPayloadError.html | 8 +- ...base_api_error.InvalidTransferIDError.html | 8 +- ..._api_error.InvalidTransferStatusError.html | 8 +- ...coinbase_api_error.InvalidWalletError.html | 8 +- ...inbase_api_error.InvalidWalletIDError.html | 8 +- ...nbase_api_error.MalformedRequestError.html | 8 +- ..._error.NetworkFeatureUnsupportedError.html | 8 +- .../coinbase_api_error.NotFoundError.html | 8 +- ...base_api_error.ResourceExhaustedError.html | 8 +- .../coinbase_api_error.UnauthorizedError.html | 8 +- ...coinbase_api_error.UnimplementedError.html | 8 +- ...nbase_api_error.UnsupportedAssetError.html | 8 +- docs/classes/coinbase_asset.Asset.html | 20 +-- ...e_authenticator.CoinbaseAuthenticator.html | 12 +- docs/classes/coinbase_balance.Balance.html | 8 +- .../coinbase_balance_map.BalanceMap.html | 8 +- docs/classes/coinbase_coinbase.Coinbase.html | 20 +-- .../coinbase_errors.ArgumentError.html | 4 +- .../coinbase_errors.InternalError.html | 4 +- .../coinbase_errors.InvalidAPIKeyFormat.html | 4 +- .../coinbase_errors.InvalidConfiguration.html | 4 +- ...oinbase_errors.InvalidUnsignedPayload.html | 4 +- ..._faucet_transaction.FaucetTransaction.html | 10 +- .../coinbase_server_signer.ServerSigner.html | 12 +- ...se_staking_operation.StakingOperation.html | 20 +-- ...coinbase_staking_reward.StakingReward.html | 14 +- docs/classes/coinbase_trade.Trade.html | 32 ++-- .../coinbase_transaction.Transaction.html | 26 +-- docs/classes/coinbase_transfer.Transfer.html | 38 ++-- docs/classes/coinbase_user.User.html | 16 +- .../classes/coinbase_validator.Validator.html | 14 +- docs/classes/coinbase_wallet.Wallet.html | 72 ++++---- docs/enums/client_api.Feature.html | 4 +- .../enums/client_api.StakingRewardFormat.html | 4 +- docs/enums/client_api.TransactionType.html | 4 +- .../coinbase_types.ServerSignerStatus.html | 4 +- .../coinbase_types.StakeOptionsMode.html | 8 +- .../coinbase_types.TransactionStatus.html | 4 +- docs/enums/coinbase_types.TransferStatus.html | 4 +- ...ent_api.AddressesApiAxiosParamCreator.html | 2 +- .../client_api.AddressesApiFactory.html | 12 +- docs/functions/client_api.AddressesApiFp.html | 12 +- ...client_api.AssetsApiAxiosParamCreator.html | 2 +- .../client_api.AssetsApiFactory.html | 2 +- docs/functions/client_api.AssetsApiFp.html | 2 +- ...ExternalAddressesApiAxiosParamCreator.html | 2 +- ...lient_api.ExternalAddressesApiFactory.html | 6 +- .../client_api.ExternalAddressesApiFp.html | 6 +- ...api.ServerSignersApiAxiosParamCreator.html | 2 +- .../client_api.ServerSignersApiFactory.html | 12 +- .../client_api.ServerSignersApiFp.html | 12 +- .../client_api.StakeApiAxiosParamCreator.html | 2 +- .../functions/client_api.StakeApiFactory.html | 8 +- docs/functions/client_api.StakeApiFp.html | 8 +- ...client_api.TradesApiAxiosParamCreator.html | 2 +- .../client_api.TradesApiFactory.html | 8 +- docs/functions/client_api.TradesApiFp.html | 8 +- ...ent_api.TransfersApiAxiosParamCreator.html | 2 +- .../client_api.TransfersApiFactory.html | 8 +- docs/functions/client_api.TransfersApiFp.html | 8 +- .../client_api.UsersApiAxiosParamCreator.html | 2 +- .../functions/client_api.UsersApiFactory.html | 2 +- docs/functions/client_api.UsersApiFp.html | 2 +- ...nt_api.ValidatorsApiAxiosParamCreator.html | 2 +- .../client_api.ValidatorsApiFactory.html | 4 +- .../functions/client_api.ValidatorsApiFp.html | 4 +- ...lient_api.WalletsApiAxiosParamCreator.html | 2 +- .../client_api.WalletsApiFactory.html | 10 +- docs/functions/client_api.WalletsApiFp.html | 10 +- .../client_common.assertParamExists.html | 2 +- .../client_common.createRequestFunction.html | 2 +- .../client_common.serializeDataIfNeeded.html | 2 +- .../client_common.setApiKeyToObject.html | 2 +- .../client_common.setBasicAuthToObject.html | 2 +- .../client_common.setBearerAuthToObject.html | 2 +- .../client_common.setOAuthToObject.html | 2 +- .../client_common.setSearchParams.html | 2 +- .../functions/client_common.toPathString.html | 2 +- .../coinbase_utils.convertStringToHex.html | 2 +- docs/functions/coinbase_utils.delay.html | 2 +- .../coinbase_utils.logApiResponse.html | 2 +- .../coinbase_utils.parseUnsignedPayload.html | 2 +- ...nbase_utils.registerAxiosInterceptors.html | 2 +- docs/index.html | 38 +--- docs/interfaces/client_api.Address.html | 10 +- .../client_api.AddressBalanceList.html | 10 +- docs/interfaces/client_api.AddressList.html | 10 +- .../client_api.AddressesApiInterface.html | 14 +- docs/interfaces/client_api.Asset.html | 10 +- .../client_api.AssetsApiInterface.html | 4 +- docs/interfaces/client_api.Balance.html | 6 +- .../client_api.BroadcastTradeRequest.html | 6 +- .../client_api.BroadcastTransferRequest.html | 4 +- ...ient_api.BuildStakingOperationRequest.html | 12 +- .../client_api.CreateAddressRequest.html | 6 +- .../client_api.CreateServerSignerRequest.html | 8 +- .../client_api.CreateTradeRequest.html | 8 +- .../client_api.CreateTransferRequest.html | 10 +- .../client_api.CreateWalletRequest.html | 4 +- .../client_api.CreateWalletRequestWallet.html | 6 +- .../client_api.EthereumValidatorMetadata.html | 20 +-- ...ent_api.ExternalAddressesApiInterface.html | 8 +- .../client_api.FaucetTransaction.html | 6 +- ...nt_api.FetchStakingRewards200Response.html | 8 +- ...client_api.FetchStakingRewardsRequest.html | 14 +- .../client_api.GetStakingContextRequest.html | 10 +- docs/interfaces/client_api.ModelError.html | 6 +- .../client_api.NativeEthStakingContext.html | 8 +- .../client_api.PartialEthStakingContext.html | 8 +- .../client_api.SeedCreationEvent.html | 6 +- .../client_api.SeedCreationEventResult.html | 10 +- docs/interfaces/client_api.ServerSigner.html | 8 +- .../client_api.ServerSignerEvent.html | 6 +- .../client_api.ServerSignerEventList.html | 10 +- .../client_api.ServerSignerList.html | 10 +- .../client_api.ServerSignersApiInterface.html | 14 +- .../client_api.SignatureCreationEvent.html | 18 +- ...ient_api.SignatureCreationEventResult.html | 14 +- ...pi.SignedVoluntaryExitMessageMetadata.html | 8 +- .../client_api.StakeApiInterface.html | 10 +- .../interfaces/client_api.StakingContext.html | 4 +- .../client_api.StakingOperation.html | 14 +- docs/interfaces/client_api.StakingReward.html | 12 +- docs/interfaces/client_api.Trade.html | 22 +-- docs/interfaces/client_api.TradeList.html | 10 +- .../client_api.TradesApiInterface.html | 10 +- docs/interfaces/client_api.Transaction.html | 16 +- docs/interfaces/client_api.Transfer.html | 28 +-- docs/interfaces/client_api.TransferList.html | 10 +- .../client_api.TransfersApiInterface.html | 10 +- docs/interfaces/client_api.User.html | 6 +- .../client_api.UsersApiInterface.html | 4 +- docs/interfaces/client_api.Validator.html | 12 +- docs/interfaces/client_api.ValidatorList.html | 8 +- .../client_api.ValidatorsApiInterface.html | 6 +- docs/interfaces/client_api.Wallet.html | 12 +- docs/interfaces/client_api.WalletList.html | 10 +- .../client_api.WalletsApiInterface.html | 12 +- docs/interfaces/client_base.RequestArgs.html | 4 +- ...configuration.ConfigurationParameters.html | 4 +- docs/modules/client.html | 2 +- docs/modules/client_api.html | 2 +- docs/modules/client_base.html | 2 +- docs/modules/client_common.html | 2 +- docs/modules/client_configuration.html | 2 +- docs/modules/coinbase_address.html | 2 +- .../coinbase_address_external_address.html | 2 +- .../coinbase_address_wallet_address.html | 2 +- docs/modules/coinbase_api_error.html | 2 +- docs/modules/coinbase_asset.html | 2 +- docs/modules/coinbase_authenticator.html | 2 +- docs/modules/coinbase_balance.html | 2 +- docs/modules/coinbase_balance_map.html | 2 +- docs/modules/coinbase_coinbase.html | 2 +- docs/modules/coinbase_constants.html | 2 +- docs/modules/coinbase_errors.html | 2 +- docs/modules/coinbase_faucet_transaction.html | 2 +- docs/modules/coinbase_server_signer.html | 2 +- docs/modules/coinbase_staking_operation.html | 2 +- docs/modules/coinbase_staking_reward.html | 2 +- docs/modules/coinbase_trade.html | 2 +- docs/modules/coinbase_transaction.html | 2 +- docs/modules/coinbase_transfer.html | 2 +- docs/modules/coinbase_types.html | 3 +- docs/modules/coinbase_user.html | 2 +- docs/modules/coinbase_utils.html | 2 +- docs/modules/coinbase_validator.html | 2 +- docs/modules/coinbase_wallet.html | 2 +- docs/modules/index.html | 6 +- .../client_api.ServerSignerEventEvent.html | 2 +- .../client_api.StakingContextContext.html | 2 +- .../client_api.StakingOperationMetadata.html | 2 +- ...client_api.StakingOperationStatusEnum.html | 2 +- .../client_api.StakingRewardStateEnum.html | 2 +- .../client_api.TransactionStatusEnum.html | 2 +- docs/types/client_api.TransferStatusEnum.html | 2 +- docs/types/client_api.ValidatorDetails.html | 2 +- ...ient_api.WalletServerSignerStatusEnum.html | 2 +- .../coinbase_types.AddressAPIClient.html | 12 +- docs/types/coinbase_types.Amount.html | 2 +- docs/types/coinbase_types.ApiClients.html | 2 +- docs/types/coinbase_types.AssetAPIClient.html | 2 +- ...ypes.CoinbaseConfigureFromJsonOptions.html | 2 +- .../types/coinbase_types.CoinbaseOptions.html | 2 +- .../coinbase_types.CreateTradeOptions.html | 2 + .../coinbase_types.CreateTransferOptions.html | 2 +- docs/types/coinbase_types.Destination.html | 2 +- ...inbase_types.ExternalAddressAPIClient.html | 6 +- docs/types/coinbase_types.SeedData.html | 2 +- .../coinbase_types.ServerSignerAPIClient.html | 2 +- docs/types/coinbase_types.StakeAPIClient.html | 8 +- .../types/coinbase_types.TradeApiClients.html | 8 +- .../coinbase_types.TransferAPIClient.html | 8 +- docs/types/coinbase_types.UserAPIClient.html | 2 +- .../coinbase_types.ValidatorAPIClient.html | 4 +- .../types/coinbase_types.WalletAPIClient.html | 8 +- .../coinbase_types.WalletCreateOptions.html | 2 +- docs/types/coinbase_types.WalletData.html | 2 +- ...ient_api.StakingOperationStatusEnum-1.html | 2 +- .../client_api.StakingRewardStateEnum-1.html | 2 +- .../client_api.TransactionStatusEnum-1.html | 2 +- .../client_api.TransferStatusEnum-1.html | 2 +- ...nt_api.WalletServerSignerStatusEnum-1.html | 2 +- docs/variables/client_base.BASE_PATH.html | 2 +- .../client_base.COLLECTION_FORMATS.html | 2 +- .../client_base.operationServerMap.html | 2 +- .../client_common.DUMMY_BASE_URL.html | 2 +- ...nbase_constants.ATOMIC_UNITS_PER_USDC.html | 2 +- .../coinbase_constants.GWEI_DECIMALS.html | 2 +- .../coinbase_constants.WEI_PER_ETHER.html | 2 +- package.json | 2 +- quickstart-template/trade_assets.js | 2 +- src/coinbase/address/wallet_address.ts | 72 ++++++-- src/coinbase/types.ts | 11 ++ src/coinbase/wallet.ts | 27 ++- src/examples/trade_assets.js | 6 +- src/tests/wallet_address_test.ts | 165 ++++++++++++------ src/tests/wallet_test.ts | 15 +- tsconfig.json | 2 +- 250 files changed, 1104 insertions(+), 979 deletions(-) create mode 100644 docs/types/coinbase_types.CreateTradeOptions.html diff --git a/CHANGELOG.md b/CHANGELOG.md index df120312..36a07ee9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Coinbase Node.js SDK Changelog +## Unreleased + +## [0.0.13] - 2024-07-30 + +### Added + +- Support for trade with MPC Server-Signer +- `CreateTradeOptions` type + ## [0.0.12] - 2024-07-24 ### Changed diff --git a/README.md b/README.md index 3c10b35c..0aef3e01 100644 --- a/README.md +++ b/README.md @@ -165,7 +165,7 @@ console.log(`Wallet successfully created: ${mainnetWallet}`); // Fund your Wallet's default Address with ETH from an external source. // Trade 0.00001 ETH to USDC -let trade = await wallet.createTrade(0.00001, Coinbase.assets.Eth, Coinbase.assets.Usdc); +let trade = await wallet.createTrade({ amount: 0.00001, fromAssetId: Coinbase.assets.Eth, toAssetId: Coinbase.assets.Usdc }); console.log(`Second trade successfully completed: ${trade}`); ``` @@ -222,4 +222,4 @@ await userWallet.loadSeed(seedFilePath); [build-size]: https://badgen.net/bundlephobia/minzip/@coinbase/coinbase-sdk [build-size-url]: https://bundlephobia.com/result?p=@coinbase/coinbase-sdk [npmtrends-url]: https://www.npmtrends.com/@coinbase/coinbase-sdk -[npm-downloads]: https://img.shields.io/npm/dw/@coinbase/coinbase-sdk \ No newline at end of file +[npm-downloads]: https://img.shields.io/npm/dw/@coinbase/coinbase-sdk diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index a4a5d793..737e49df 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE62da3PbNhqF/4vyNbubpGl3m2+KLTfa2rHHl3Z2OhkNLEEWNxSpJUHHbqf/fUckRRHAeznw9FvrnPMcEAJ4fUH+9sfE2Sc3+TBZ5pkt3OT1ZGfcZvJhsi1XTW7rf3R///vGbfPJ68nXrFhNPrx7PVlusnxV2WLy4bcBMV2tKlvXIuPVUdSx3r/98f13b97/+TrEfDS5KZb2PKvlVr0i9QocpmI4W093GcQ7KBHg9Ckr6ytTme1JZY0rKzyBsiKRZ2bpyuoZDzoaIPwugbwDofPC2WptlhZnjy1sRF1bbYz0EhEBDI2RTEWlDgrJp4ZhwyFW62BtIHhCFYcOAUrPwfv9iUw8ilhMVZrV0tTutjIre23/11ht18NZkIiiXtsqOSVwsUFNlq9unPmaFQ+XO1sZl5UFFiY7ucCTslhnD00nlxNCKYRs54N1tlIOWryJjdlPMtvvc6AuYhxywI2tHm11kz0U4K8u2eQofPySehWOj1zOIkf8avLcuoSA0JCA7/4nOWSwcVEzt7GVbba/mDxb7XfiF9aZlXFGjpJsbNSTs1VhcvwMh3GkBCQe3FBEShOgQ55sTIpTDoSsJyUEPDxqVi7yzDRL2x1GzFLfU1NyFm2Nayql3UcRj3HLTX/4ubbfTLWq3715c23rXVnUKl3xJoRCex/Rx4X9ZF1vOSmL/d+gKMHFBV2UK5vPqkqbm56Og302Lnu0M7fxWyGTeRMXc2Uql5k8MUdwcUE31q7a3U5WFrNH7Xr6FSWH0de2bvLUgMHExxzPDDS2p0SAUJfEchj9En5yiH7rgLMgEWn0BLB+/CbUKDjxuI3Y0WjoeM2b4BjlOE3qUTh4fJZsbFT2ULRHx5TdEudJC4F2ULJTCrSrX8q8KZypnmdPmbuwdW0eLHZCDPnZcGe+Wn02HVUaKHX2CDYtCpstkVjFarNjrNNg6Gwg5BIaPezjB3tP+AI2HDHcMYHoYzUKBqcN70KDbpxxTT0rmm1alOdTwrqTZog/SCHkWVltDfYTBwYIv99GC3dN7OFC2jsxMvMgERH6uclYJqL0s5GxTEUl7kFFnxoG7UMJtQ5W9qK+UMWB+1FSL8Cxi3zs8n6kQncMnAWIuH3e6X0RiEXsWrtGGqk0EDS5xkoNmNShoV6DQ/N3rESA6bNYtCKR6FwmDBBen9G+FoHi85q0cBF3tTaae4UE0MfFSKWBEseDZNOioHEQi1Ws8vt7Og0G/u6UnEMPDwRk5Fimok6tM1muPFAj1CpY30OGUhWpD9dQCiETB67qhUKhIcw4sABlMMdiCAsOa9bDhSDP4NQHbp1AH3meToaN7+Kgx2jFKQfqg9zT6bDE4S0b9ThoYFNyAK0M6UCpA8HBTBs4vOF/v4XZZVBtXvQgzRbN1qP0Cp/2L/RSOMIRah7NnqRH2EDJI+nn1svc7P82Jo6FPu7tOw8YF3NRtINKQsnP1gkqZZAC+Bv/BDwUi+Do3icF7EUSiLgLQJAGlYIirklo2iCUgPGJLAE7iCQQc55B0DylhKR26QTvKBOHdFiwmx32RtQMCfYz3/8A1uyK0JED4CeAQSJ3p0Rk+yYxxS8iZah7kUpJa2jkkPhRqSMN7WUiSa52ZLiUCU2hy8b0oLFPzIJqHpk8wStlysWDdBbl0TPE+kEpiDDqaSmDInZA/JThQJr0FKaQUMrwLIkJ4XUMnNP9j5QGlBPSaaxRTMMq05hEySylCsVpdFJkEOlgYRkTJboTc8EByTulPL28jE7jfFIWVWFG049KiacWmdFwxiYl6XVmdBTnk7KEUjM6JDIk0cNiDjCjs8lJVMEZhz9qUSbYN4EhiY6clZImNCU1IIWdtBdmjWKaUoLERJGu9Bxw4ApeLRMtROKTZYKYz9fMMHGhQaPje7GEfRdb1iKSBz3ADmtARHAnlqhBCQVNa0UqBZnMg1ClJU3f2KHw0XMm8Gwpfmgu4NbyPp5+bi7zgB6VnrLKcLhf/QetNHSv0RhJrYwMEp14LEhTByFEQ34qTwxRk7qBdkk52OWXfq1FPUmSWNr2i88cJDB+3FbK693zTjnHoQ7Zb37859vv3+FllHEKpQdDhHpHLieypEZRz/jUsKMJjGMrCLmowKDFKJVaUQqph0KY0iU6wRNreL5EIYKHUg2NPdqNYiTbXzHOHk2VmfscHWt/e+uHfpcy0KSswCTmKCONjCE9egoz1PgIzyDysQFBJklWMRNcSbtuiran2CcbkdfP/AF+eYia1DtQ/i4FvZOowNs06ATWiKSBHRTIIbLaNUelwEtck00mQYzENmAdJzhT87TupE1CSsKKOTJQ9SdkY73JuFJytF6MDRJdXy1Fh3A+IAvsKV+NcNWeGYQCDVn+QNJ5I5KGdUooh8hat4yUMg+pKecSeC+YCXdQ6ED5QDeNxAIVqLQmA1gfkIX1TqBGuFqvHIUCDa3jJRNkM5qKdRBlgRO0rgrUAheqCiUzBCeUh3VTpMfYWgeNpRHxy4h5b/j3iyz2/whVb340tZ1ezdmSrxbUi6SCr/3T16yyq+DpKkXzpBrT1m5aPYiFZAO014o1N9Ob2eJqevtJuFLqNvkgFK6KTi7Pz2cnt/PLz4uzy+uL6e2NRo0dAr4cLqPbk5kLs9PwsSPCj0fQstxu+dV2i+6foVF0endx8Z9F22d31+dCM3umrxf6YD96KtfO4NlTVrtamD09O7II83LZ1rb0Y+esB+oRpE2IqW2VmTz73Z4aZ+brz9au7EqPIW1ijJvusp/t8215ef9fu3RIRGCR8R9NnS2njdskJUQuJcSaylbpKZFNjrlMTrjE4TfWVMtNOwiBIRsYBLQrr8y+lqPKigedO1aLx5Il8jbEhaeC9gvMWxaDo4LPPeFT/MOD+r7F+FAhJB0B8fHjS9BZWdEffKltNuy7invfwpBVz+Cbj4e+C2lkLbXfY7a/t7CA27gILVCjg3sYeuPjmAARb9X4F/nWnjMlbJVvgLapOy/DtyiI8OzU1oy3x+yyhWVehDbkHDTYMLqac2dmMfAglobSNK+sWT13R9gEdGSTQrqCyfNsm7lra5Yb/vQyTmK8Uty8eNxfnfQ/Eh5F+PCY+elLg3onErUtm8Kl5xxtSMj+PvBLtmbkA2JObe2yoqukSo0KvUBcO4CSg44uIOKzdd/K6usLus53AlFX5sEmpwwmIKCrObsyz3lpEiYr6wYiD7ekXtB/gTUhrH9u9tLAkR0I7Y4dyWEjGxzygk70jFLQhcnXZbW1q/7CCU8inVJUPzH6had3Rd3sdmXlUo4fMkIML91Z2RQpWWOHfEekLptqaWdPG9PUSdtDW6Wwu8I0blNW2e8pOZFLjsi2u9xubZG0LbFNDhl+u/ZYk5JDOOVTUcN822GAEyvymFM2nxQ3syURK/yiJjVuYwuXLZkF9QNwrAMv7zrrlE6Im+wlkG55U+7ZLyccIu7JlYTcvc+AFjX4QCPXJzKNW2wNtfY/QO5VKY307v5x7WyhR4Pc3NFlLNfWw38kDQahmQPvhATHLSxqZwonXdENGmxO3V5ezE8Wd5/ntzeLq9n14u7m9IS8XRnzSa9w6/KnX2fzxensZH4xPadvDMcZnkeqAZrN2ybMbj/NrkG25xHvC7c7P6nTOwHW49VDs99PazvdHunJ5bOW7v4AyPXkyMXM1fxn+xy+ioKnRyYgQ7s5RofAt8d6/V1Rj8+q4ZzAJ8/UdXuxvXDiO/wOObEYGknCcstoU4gIZfFluEV1+wRlUXOvKz8keTpoO+hladEm+GB+fVrU8K4uclEKb3YdMkIttgHsGpt4I6IAecENtzEV997VMKii1tuImxEu52G3oUcLC3vC1jvm7agHsiNW9dBtDRYJRW3sSMQqIaJJwAxNnZrYpBxT4Xno+Ldhetx4TY/Q1LU48wYevVgoauG+9Fpq3v7fk/cM3R2CI7Z/XZEPjQ1+TvR+nctd+5hov7pZQwdyHhxVSCvkSK+g12Bn+GIe2t89nV7NT9qHQlERvY8N5cEvGRXPdzdNNWgrUlG7rMuM1xMEuEGoIveXi/Cme2INfTinP5yg2LOq3P67Lot+FClhmh2NT0tD4d77PMAIyqMFje5QK/iRUoMGz9LQn5+zaXH7pfqn1AqocOfVyXTccSeHNp30qEFtZSya4Ik1dHtkhqdzoAbg7RBDmx7ptYB9eSMK97QaeCgGROmxQYvon7uC/ECNwbuJju0UCAcWAkyoo5BGjk9aGvqVzAdgEy8Spk9Z/BXH0alUy4lXHIenUI2jX+s7YFy8UI5uz7IsHm3lupKX2/KTfSKrZHxwbBIqcFY2N3RpqA9tdQInLx+muyx+nw8L9A0CeWeq2rKX/SyfsgkplX3IamertsS2vb2ytDvn3Tdio1ivWKT0KLxS+sAfNNBoIVajR0P4SGSWpNPFKEIbv1EruqWiE6F1PYtaJB6XlWTFajwfDg1r//xX3D6Nga84RxfDfn1bZqLfeSf2+jxuLGa5wbk9RTtIWAZxFkBxxjKWRd9cpXCBkiXSj6/GJOTL5GDPh1KOyX4wewQDvpdNPEnhQZ2MY8UPOwjSSKRx9IsmgS+YtdyUGIAqXyZRbMbBJZDXRwTX13E0tk6RIMZakIrNBcHE5QAfxx0FpHwbl3l0RVBDJUdkHtcQxFDJE4UHNSSX0it05SvxMR79Vrz2cIZPiC1cRnwdTlBHIp4jfbjVYyV/txWbHJwDSQjvHSr4Qc6ymbsEFDeUikzy3ixH9cUSV/7IX8BN+8Yf9zW8GKp+DI/5kNyIBH1HDjy5irUCFdq7vvCjZChTHZX8R8NCIPbNMGyAU2qNjG74GpiL9IelRiTgu1LYloZKjijd0SKwpJxjM0UfBDZUskTmUnWMwr5jg21urFWowHlZqJSJzL06lhvqZbp6tPVkPuvLn1/+Dwyuq3IzjQAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE62dW3Pbxh3Fv4v8mra246SN3xSJitVYlkaXZDoZD2dNLiU0JMACoCy1k+/eJQACe/lfzmryZkvn/M5itRdcdoHf/nfU2qf26P3RYl3Ysj365mhr2gf3/0213K1t87f+5399aDdr98vfi3J59P7tN0eLh2K9rG159P63EXG8dD9pGpHxahL1rHdvfnj37et3f3wTY340a1Mu7MeikUv1itQrcJiK4WxzvC0g3kGJAI+fiqq5MrXZnNTWtFWNJ1BWJPLMLJz4GQ+aDBB+m0HegtDzsrX1yiwszvYtbITTam1kkIgIoGl4MhWV2ygknxqGNYdUrYO1hhAIVRzaBCg9Bx/GE5k4iVhMXZnlwjTtbW2W9tr+Z2e1oYezIBFls7J1dkrkYoN2btC/aY37/f3l1tamLaoSC5OdXOBJVa6K+10vlxNiKYTs+oN1bUGZtHgTG7PvZHYYc6AqYhxywI2tH219U9yX4F9dsslRePsl9Socb7mcRY741azXts0IiA0Z+P4/2SGjjYuatQ+2trvNL2ZdLPeD+IVtjfuHkaMkGxv15Fp4adb4GQ7jyAnInNxQRE4RoClPNmbFKRMh68kJAadHzcpFnpndwvbTiKsDdaSm5Cza/Ql3tVLuScRj2sXDMP1c26+mXjZvX7++ts22KhuVrngzQqHRR/RxYT/ZdrC4uWr/MyhKcHFBF9XSrmd1rfXNQMfBPrkJ9dG64SkshUzmTVyMGw7awqwzcwQXF3Rj7bIbdlyrnj1q19OvKDmMdi1wt84NGE18zHRmoLEDJQKEqiSVw+iX8LND9FsHnAWJyKNngPX5m1Cj4Mx5G7Gj0dB8zZvgGGWeJvUoHJyfJRsb5dTd7JgzLHGevBBogJKdUqBd/lKtd2Vr6ufZU9FeuDMWc2+xE2LIz4a72cDqvWlSaaDc3iPYtCistyRiFav1Dl+nwdDeQMglNDrt45N9IHwBG44Y75hAdF+NgsFuw7vQIPf/dtfMyt0mLyrwKWH9STPEH6UQ8qyqNwb7E0cGCL8/RgtXTerhQro7MTLzIBER+rmJLxNR+tmIL1NRmSOo6FPDoDGUUOtgZRQNhSoOHEdJvQDHLvKxy3tPhQ4MnAWIuH3e6nURiUXsSrtG8lQaCOpcvlIDZlVorNfgUP/1lQgwvxeLViQS7cuEAcLrPTrUIlC8X5MWLuKu0VrzoJAAervwVBoosz1INi0KagepWMUqf/9Ap8HAvzsl59DjAwEZ6ctU1Kk7KSzWygM1Qq2C9REylqpIvbnGUgiZ2XBVLxQKNWHGgQUojTkVQ1iwWbMeLgR5Bqc+cOsFessLdDLMv4uDztGKUw7UG3mg02GZzVs26nFQw6bkAFpp0pFSB4KNmTZweMP//ebud9DavORBmnVNJ6AMipD2D/RSOMERah7NnqQn2EjJI+nn1ou12f/MJ/rCEPfmbQBMF3NRtINKQsnP1gkqZZAC+Bv/BDwWi+Dk3icFHEQSiLgLQJBGlYIirklo2iiUgOmJLAE7iCQQc55B0AKlhKSGdII3ycQmHS/YLQ6jEdVDonHmu+/BNbsi1HMA/AwwSOTulIjs0CSmhItIGepepFLyCpo4JH6y1JGGDjKRJK92ZLiUCU2hl43pQb5PzILWPDJ5glfKlBcP0lmUR88Q1w9KQYRRT8tpFKkD4uc0B9KkpzALCaWMwJKZEF/HwDn9f6Q0YDkhncYaxTRsZRqTKJmlVGFxGp2UGEQ6uLCMiRLdmblgg+SdUp6+vIxO43xSFrXCjKZPSomnLjKj4YxNStLXmdFRnE/KEpaa0SGJIYseL+YAM3qbnEQtOOPwkxZlgnUTGbLoyFkpaUJTcgNy2FmjMGsU05QlSEwU6crPARuu4NUy0YVIfLJMEPP5NTNMXGzQ6PgoljF2sctaRPKoB9jxGhAR3IslarSEgqZ1IpWCdOZRqNKyum/qUPjoORN4tpQ+NBdwK3mMp5+byzygRqWnrDIcrtfwQSsN3Ws0RlYpE4NEJx4L0tRRCNGQP1UghqhZ1UC7pBzs8ku/1qKeJEks7fjFZw4SGJ+3leX17fNWOcehpuzXP/z9zXdv8WWUaQqlB0OE9Y5cTmLJjaKe8alhkwmMY1cQclGRQYtRVmolKaQeCmGWLtEJgVjD80sUEngs1dDYo90kRrL9Ge3s0dSF+bJG29pf3oSh3+Y0NCkrMok5SksjY0iPnsI0NT4iMIh8rEGQSZJVzAR30q52ZVdT7JONxBtmfg+/PERNGhwof5uD3kpU4G0adAJrRNLACorkEFmtmkkp8DL3ZJNJECOzDFjFCc7cPK06aZOQkrFjjgxU/RnZWG0yrpwcrRZTg0TXd0vRIZwPyAJrKlQjXLVmRqFAQ7Y/kHTeiKRhlRLLIbJWLZ5S5iFryrkE3gtmwhUUO1A+UE2eWKACK63JANYHZGG1E6kRrlYrk1Cgoet4yQTZjKZiFURZ4AStqiK1wIVWhZIZghPKw6op0WNsrYJ8aUL87DG/GP79IvP9L6HVmz864fHV+QSKlnx1oEEkLfjaP30taruMnq5StECqMW3THtf34kKyETpoxTU3xzez+dXx7QfhSqk/5INQuCo6ufz4cXZye375aX52eX1xfHujUVOHgK/Gy+juZObCbDV86kjwfgtaVJsNv9tu3v8aakWndxcX/5p3dXZ3/VEo5sAM9UId7FtP3XY9ePZUNG0j9J6BnViEfrno1rYMbedsAOoRpE2IcQUq3Lj3X3tqWnO++mTt0i71GNImxrRu2PjZPt9Wl1/+bRctEhFZZLwbCIrF8a59yEpIXEqINbWt81MSmxxzmZ1wicNvXGEWD10jBJpsZBDQbXVl9ms56qK817m+WpxLFsjbEOeBChoXmLcsRrNCyD3hU8LpQX3fYjpVCEkTIJ0/PkeVVZTD5Esds2HfVTz45oZc9Qy++Xisu5hGrqUOa8wO9xbmcBnnsQUqdHQPQy98GhMh0qPy/yJfu3OmjKMKDdAx9edl+BFFEYGdOhr/eNx54NwyL0Ibcw4arBldnXNnZinwIBYX+K/dHLh87mfYDHRik0L6BZMfi03RXluzeOBPL9MkxivFnZeP+6uT4Y+ERxE+POb89KVBgxOJ2lS7ss3PmWxIyP4+8EuOxvMBMafulKso+5VUuVGxF4jrGlB20OQCIj7Z9mtV//6CqgudQNSVubfZKaMJCOjXnF2Z53VlMjor6wYiD7ekXlB/kTUjbHhu9tJAzw6E9nNHdphng0NeUImBUQq6MOtVVW/scrhwwpNIpxQ1dIxh4+ld2ey226puc+YPGSGGV+2ZGzhzsnyHfEekqXb1ws6eHsyuyToe2iqF3ZXGXe9UtbsAzchJXHJEsdmu7cadm+dlxDY5ZPzbdXNNTg7hlE9FDfNthxFO7MhjTtlCUlrMjkTs8EuK5P4erqaKBbOhfgT6OvDyrrce0wlpkYME0i0fyhf2ywmHiC/kTkLu3mdESwp8oJH7E5nCzTeG2vsfIfeqnEIGd/+4cnbQySAX17uM5cp6+EdWYxCKOfJOSHBawrJpTdlKV3SjButTt5cX5yfzu0/ntzfzq9n1/O7m9IS8XZnySa9w6/KnX2fn89PZyfnF8Uf6xnCaEXikNUBOti/C7PbD7BpkBx7xvnA3+EmV3guwGq/vd/txWht0B2Qgl89a+vsDIDeQIxczV+c/2+f4VRQ8PTEBGdrNMToEvj026N0c5p9VwzmRT+6pq+5ie96K7/A75KRiqCUJ2y2TQyEilM2X8RE13ROUecO9rvyQFOig46C3pSWHEIL5/WlJwft1kfNKeLPrmBFrsQNg99ikB5EEyBtuuIOpufeuxkE1td9GPIx4Ow97DANa2NgTl75l3o56ILfErh66rNEmoaSMPYnYJUQUCeihuV0T65Q+Fe6HLf82zICb7ukRiroSe97IozcLJSXcL72Wirf/ffbI0N8hmLDD64pCaGoIc5L361xuu8dE+93NGjqS8+BkhbRCTvQKegVWRijmocPdUzdZn3QPhSbssIg+xMZybfF8f9NUg3YiFbUt+sx0P0GEG4Uqcn+5CB96INbQh3P6wwmKPaurzT+bqhxakRKm2dH4vDQUPr0yBOQnBjiia8SZKb5HC/Jugit4T6lBo8d1aAvjbFrc/m0Ap9Qmq3h87GU6bhpH0aKTHjWoW3yLJgRiDd21NXjEiNQAvGtiaNETvRawX0GJwgOtBh7XG6L01KBFDI92QX6kxuB9R8cGBcKBhQAdahLSSP+8aEe/9fkA3KX7kOmzonBTc3K21nHSTc3xWdqupd8cPGLadC8eXZ5FVbqO3/aram6rD/ZpwnoLcUJwahIW+Szt2tCrT0NopxM46+redfH0lUEsMDQI5K2pG8veWWD5lE1Iqe190bgJolvF293BWdhtG9yaYqNYr7gO6lF4a/WBP2qg1kJseE+a8ERkdr3T612EMn6lNo1L61qE0g0sah96unLF/djvD4eCdT/+M+7QpsBXnKOPYT/wLTPRT8kToz6P88UsN7p8oGgHCcsgzgIoji9jWfT9WwoXKVki/YTMJyEfPwdrPpZyTPab3B4M+CQ38bCGB/UyjpU+TyFInkjj6NdlAl8wa7k5MQBVuBKjwJRcZdOXYBI+cnAJ5LUXwQ11HI1dZkkQUy1IxfqZYOJygG/7egE5n/ZlnrwR1FjJEZmnTQQxVvJE4TkTyaX0Cl35yH2KRz91rz1b4hNSC5eRXuMTVE/Ec6Tvzgas7M/OYp2DcyAJ8a1PBT/KWTZzB4LixlKRSd5a5qihWOLK3yiMuHmfKOQ+5pdC1W/5Md/B80jQZ/DAE7dUK1Ch0fWF31RDmWqr5L95FgOxT55hDZxSa2T0wFdAX6S/i+WRgM9iYUcaKzmi8NUmj5b10SasgKScYzOrXwhsrGSJzAW1j8I+6IMdbqpVqMAZXqyUicwdRZYb62W6Om8HspD1+Y/P/weqmo+cPI4AAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 50f8ff74..028d588d 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE+y9W5PbOJIG+ldOuF49NSLAC9hvHl9mvNvudtjumXOiY6OCXaJtbaukWknly07sfz9BgJSAZCbuUm1M75PlYgL4kAkkEh9u/3yy237dP/nh138++X21WT75gT19sunu+ic/PLldr/rN4c/d/erJ0ycPu/WTH57cbZcP637/Z/XpprtfXX8+3K2fPH1yu+72+37/5IcnT/7n6TGvqj7m9my53PX7/TGr1ebQ7z52t2ZuoxSS69Mn992u3xxMYKeyigUrj4V97dbr/nCzWgYUd6UnchU8paQAbPrD1+3u90AERqpUCPcPv61Xtze/999DIBipUiF06nOgFoxUERCQVveXbt1tbvsfV/uDHxItQWpbXHaHLq7QqzGprw70WhJgPnf7m7vtro8EpCXPCGrTfzvc3HefYlHp6TPCOmwP3frmdvuwiWw0V2YOadCQVu3fnC/bjqMbcL6Wm9RkM7bVtEaatXWmNktbe9zveyeKQSa1DfoPq8fSQgdVWRVqPBs+BhWupUgretnfru66tTN+OhWtpUgr+na7Oey628NN5xfCnSAgKYOh6O1s9IwOAKNUalvr7jz6ll7W1TGFs5JTRWztLKjkMUFEwYZ+d9tuedvtDx923bJ/1//XQ+8cYdA0qbrfrz5t+uXNffd9ve1c3Y1GcDXLx60gVAWUne7vd9sv/c1h12323e1htd3c5ILulXdydSjrb/Yf+114A9CTPVobmIFIbAaGLgjVPazWy/eH7vfV5tPP9/2uG8zlqT5L0osNl04QgaOoVR9pg6sbasiYGwXUd1brATVoqhsFVnqOdKBTNmcBub0fhFyBhRvlKZ9cMOuq4qdufnNz+H7vDD98YV4fs0tCez3VGndNz3d9d+jHGN7PJWFJUl2RNxtFFh5ITaH1pjrJ4dDvD51HT6HRmXmkwptb8H2/+9Lv3g8jmefATKZLHplllioa2bndoB3HFZKbp/YwlRCQ+81uu17fDZA8eAwH4nlm+QGv9jd397dpOI95ZIE3b5IBs4R5gotMz4hiA2ZqSE0JQB9327sbzyCGwgXzyAjvsE0FZ+aQBg1tTAGTDjTNZZvUfJoR0aqIuUVcFG+BFha+B8ELbVWI3mJalQ+0Zb8/rDb+4zqKzswkGeC85f9DrjuGtHsjRZ610shyr46pPRVjVtZbLf+IBKn+c7F5tB1BVC/E1EDAfNj3N0Y0lYYWyy4LaN3WLw+f+13/cPf3br1adoft7k1/6DxCNDJdqq1Xm2X/LanwqykLp7LoyqfOohwIw6ZSwTC/rg6fl7vu69pzycCBFssuP+j9utt/7l093AH1lEl+gAMH80WOQy/vt7ef04DOM8sPuP+2OmSAqmdzvrba/bbuM4DFsssP+jevhTAH1FMmZzD9x4/90ML6myxQseyygNaHolfdw22vCH8v1nQmnzr06Es9n7u9qyXi5V8huThVNa+6B8T1avN7OsQxlySI4mTDvjs8aJtE+s3DnYlICcSY6tRSpujer5grTdxdzbECVLlLz7pdTbJpJSqtexZ5FE4rU6ehPEsGSSLKNxxBf7j9PLLt7/qv3W65Z4vFu35/v93sXZ7MnvgCm7A8AHjvy3JoIm2rlg/QkN1bcWB9N3T5oA3a4+UN19E0/YgDOuHFJscOCIGzY4sm0ogqF8wQtioC5HFF2DVpcuI0cjoD1P2h2x1uDqu7iK5jrgDpGZ0BaL9Z5oCpZXMGkB+3u7susRdfHTPJA1D3PH/tD6P48+3m0H/zJCypZBfzOlYAgT6H1EGax7FDDPE3wQB9t7I4IAZtYwkF6bc7xI4wYGeIB7yIXSFe8AJ2hJD52XeDvNku+/XL3W7r4oZPgqk99Xa7dCkHFHY1JnEqQasNUfhdv9+7YztY/ilVHARd4z91A2/x8vDZNJcDEZEqeefGofu9H6gpT1rGBuMKy8ypL0od1JLGJitkPLvcoG/X3eouF2QsswyA9Sb6ttsdVt06tI1SyS7dSK044lopqZFszdQOOrKdhsIObah20FEt1QOy3lTf9/1SLjEOCxdfeudujZn8pU4W4wWHnTGeV9YO6mHvsx3PjuyURxI8q83e9fuHdbDlVKpHs59WfKIVx+qfxZYIyhSL2qH23w79ZjkcrPBdlrbixbPLDXrf98tExZ6yyADO7CkI800BPIleeD/vrOioLbxGXa19wTXzm+M5pcsCw2sv7hyF//ZbAgTVNPwGPiD/iI1EG2VSW4p1GOyj9XI1JU0CwxZtU1SMtplpuGGqb8cWazhrw/G4NQBNc4GlK7pc7xUrvLppC1UWWCHrU0HQfJelLNiCVqOCwPnfPWCBF3gLgQsg1eYDm/sjtPS0Rp65fac37dytOkODzt+WszRjWwtefdrILQpBk100UfrA7xUw02UHxct4vVMncxZwYXO5GHieUzk3xpCZXBBQ72UgG8iwRaBIgB6bs70w+u7QDoM5hLWrzSfPOwusXWaWU2ao+hY8j+UrG1YkqzOCTWqjs4zSgbq9th/dZUl6Mc7LhSGHs8zJfvniTXacdtCJ7lMHnMOJ2sFm6fg65Hzd3x94Bk3ncgUOtnFKk4xXzykXVOi7+uXft+uHzaHbfX/5bXV4o5bBPU9kuTNI9WNfpo38A0Pswzb7IbrC8vVSsUNf9E4v1755X+RjVmcEO16d9GVKejOcxsmEnso7b3WMRh6yvp13Vfs2tsyrU0q3Ysg1VEhNGoJQH3NmEhNPJSbBdTZ+mjmKJ5/zdA4hWIFXnkMFrFvqLkYcTNjuRV9Q/uEMCiowhPEENVyt8+BcCUIBHZNmA6PFDnGQQAbZgN15DtUoKC1xCiA+8zJHqffSEi83D3dHgF+63WrYM2LFd0r3pyKi31u3a8YBuPLfqWlRAmHF15vVsCdm9d/aaeQkmNdmjgmQpx2qBPK3/Wa52nzKhPqU2/kQP9/e3a/7Q6b2cK1ldz7Mr7rVOlvTOGaWFS8Rb9g8ARV0YOVFRB4OQLNJjhNOwqwGCYPUGQw/v61kk287ChzmtVLjxvixivSimXOSPAcypsoDwev+J0wb3vc+ecEY4pUIVUzJ8oDwOo6EoPA/gUTBmMcPSmTo/r137ADSXDZuwAsPjxlgxTOMulZoESMuyM8xcr1Y7Q+71W8PB8/hy47WzC0bYmKooFohNVDAcsLbn8AhvDK75uxkPCKcdt3BL/tleGlXKlWYVcaqoSjUmYYIIMeEiVj0Udu8iQH3jlLmYuccT6UF0gKqKolLR1rpQWtE1sK9IxSt9LDIxFr8YfgYVLiWIq1odQ+oTziilW4mygHA4xmKWfm+L1HYVb8Nrr2eJL3wsJprKZKbnOflQ2ar0xIldrn5qxMBfQ9NHAxo5mc9tvAd5S6wd88sy3vT3qkqabv1QPEh2/ScEHz35wEMQRvznCD8d+QBGIFb8TAgoO3594Fcd4CFjPfmpVrBo77rri/lzwPGYBPPPHkOUA+boHdhZqiQ9DlgpYE6C6TA2+Sy3COX/wa5LHfH+RjQZ31pbjjvpSUcgsZ1aAK+yyRokgsxHbayA4gOvNYpPIcHsBCaA83OwXKo7QnpMI/5nAXl8YmrdKB6VmfB6rdK4wM1ZIEmBqnP2owPTv9lGU+UkNWy+5sZqYWXksJpaTl+0N3NjNgBgmlclvvqTqy4oCs8YcUs0eVH5znfSeyyceVUYExQ+dF1njcUQyihZIUQFs8eMUTEsRYQ/u9SmCgCn6Jw6sKTYtH1EEKx2Av3uxsNFB9wF5oXgPDScxR9GL+HVt9MlweG/wTXhBHE71hhxEzpjlii53MWQAlw8oOJmcZhlgqbw9m04z1TOmklbJpkFg7nSB/7XdAEyZC/5OwIKzh0amRWNnleZIEUPCky8so417BhDJ9ohKAMmGXYQAZPMUIwes8vbAgDJxcOfOjMAu+l+LTCzD9tO9WUod+awVH0MssGZnEhKwenOiUvHgAQgesHTiABSwgASegqghNK0EICABO+loDB0VvmL3vnZG8QOfu5hmMhnmcZJG6q2a/29+vu+438r2+xIFEoAF2nx6ddHIUf5fIdQXPq2SzzCqR01vpUtdQZPQASNqV3wvCcxwEQIRM5JwSviBQA8A9JncUv+0O3WgeWf0oUBQCOuUeZFwDMbMSFkonj7TE7jwHXkL3AiDsvz3vINauVNuYiMEIGXS8ovqMugiVo2KXA6E3C663OPA9zOt2O/p6ln7exP7Hp7XTjn/20A1j2H7uH9cHzYUUdxTxlIpR+M8w8ljcf1WNKIViQpIlgzIsFvUYEHRCRPByUxlaob/qFT768hS3lhRgMDwgBXIZVFXZWQ79BNRfkazzvpGo45u3P5POFQ4HZKmFkmRk7jC+82vIs1rCWmRZ3qKw9go6T4AUiDlCYd7ih1SYt1oAAQgINNwjfKAOiCAox3DD85/UQSOCsHoVSa51aDaX9/tn96tm31Xb/ttt1d9KjaFPSjw8bddJbR2ZNmtvDRyK4sov4u397PnYtUtdpyHfGn4Eo6JwVvYZFnrPac4/8aAY26z3+8U/FZRQAlE40hk/94aItwSjvj9IMTpWe2gC/UBvQ1O1sAH8BD5lcSCV/8X/x5F+uOYx1n1pFdfFWMSmfaBzr1R5IXshN4AX/URoIUvupiTQXaiKYAdyN5BGaxx+1YZyaRHv5JkE3hp16S1G9Z/7qYbO8UItAy/2jNIt55Y+x5qWCTUT/znnfq3t/9by6v/jMbizyCvwtbu726h7812CMSpE6O7OCTZt/zaBjnJdWg5gphR1+/KQhHntwNOxbhch4N7QmSaGbvS4ZgrOE2pylHuevQcrAaK9G+tDnURfKhXe3h+3ue0BVVILLO3Ot3CvsQ6RbH1NjOsns4P0qkOjq6eqcw+l7VinB/WeoT/hAEFyt2CEhunZpg4Nn/XIMEzlqeOa6XbJWSYOIZ9UyDCdB9dNWJvUEr6dVKcc6FZomZoXU7aNDAVwl+eKTAvxdbjDCeNcaAA960ASUkZ7SCdbmEIPhZnB8IYAzQT0DSIu7Ckaa7pYwuAUTqPc54hxLoEBGOJqqOO0Nud1u9ofdw62+5u1T4pWZ8FT6Yb/802r/p9Xmc79bqcsdXWoJ84F+6FL8XoC78wIT7+LCPVsgoEhvFuPEvJBlcFxh/ioUVT48FtfkBSrdHZHbM7abj6tPD+BlD1+vYCSd+YX73fbQ3x765f+T5igMwL91+/5td/gchlVLdRmY3UBdh2GckpwNoM6qDMc6UIrdEeKT6S7DsdiLv7J8D2Bc6EwsarNseDDuLzhPva61cs5TwSwrUNmqGba7KaG+J8Xa+5FzdekkeNmecmRztT9E9IWBtNXqaolVAlo7jS2uPZsg7bTyUc6LUwbSFzahwaXAv8YYc6JMoBIymdUDb6SBCeAOomeS9mZ5ZglSKZ6ZBoMKvopSlnMGOglaw5RJ6EJzT6O45InnsYa+ZnFDijJFevQ900vu0NsF1SvuNlHmDbpdAN0Rt4kuY7iNQNOGmpffDv1u0631qDww7PbK4iKDkj+SKz9R/+HLLz8/bdPROkjvtR53JqVc2+BcUl05Yv+L6yhoipBfWRbjWXa24ikc627nUq0d0P81QKeWgs5fnKEJ2gxo31E7pfJe+z2Xdq14/q8JupQUdNbjDC3QYj7vWMlFreBpHi0amkgN4ltavPPqnvizZYaTK6Lxqlj+mIWssseenGzDqV/dzzBgxtY+px/3q3x+Tx1Qd5cL8SH5LAkfz5noVJpNINGtjLnYdHcBBxNW2TO4GrcaLup0AvVxDveTrJGsjihQIWdwSVH60LhoLKEvLW1Nm4GhdvTjWFBX2fup1341VzeMrs4Zupnv3jZbL4quT/5e4lp5wNLYmFtM/jLrEWTJqUsTqAqiu2YQ8uzdMaUXBiE/Q89L6HBB0PN3suQ1JWvbzry8FFIBn5UmGnvWRacQ2M71JxpzvqUoB2BtmqRf9haxIuVMfpEpkx+KK7eY//TJnZdbs9arsvTkF639NVr+JRSSg1s9vzKCFpTyaQUzC718+XitZ174H7XpAE0ErQJlbDfQIJZlR13u5Zd+c3BMznNrjMTwR21CuEKCVnMytiTCPJ4N6pHb0v81I0046GKvM7YgsvHsH367W5k3Eff9Uja4d/3+Ye3Yg5pbgT5w/qiNy6mboCvDMjY2t9H8G9/q00befP+/qQXimP6vGdoUFHZF2XkbI2Y/rzm6ayfEXP5RZuHTejHy9/h59qt75E/208TxcyFnDTLNldFKue+KOWfFMkzjYmqVYxbirly+eUaOOp69eherWeaozV3Ts8RlmWqeHDJEVT9TUOCpA9sg5bPXhkj0OMOVvquA+pgwcI05UHo61xDmX6tcg5m9omcd1gIqm2OAS6pplqEuoMIZB72s9b5glR+htrmHxIDan2dwzK2N9GEyTSW5BsxgvWi7wWAi351gZLo8V9GhjjgGyVWekcXn9rd8mDMMEF4b1CxjQBTufH4+GH5m5OcB7e+RoypxFq8bUymbY81Vs0zO07VREMrbttdA2ctsEERLTd0cOKt2uLf2h5rFQ4c6Zm94GZxxpA/2hpjP74a722iQWfH5e1ZvvGfxppmcaEolMjnO5M2fpN/KvPHTF7jPpk8cc9YNn75wnZs9caz5NnpagOrc3KH7vY/Y3Ekluww/Zy39iv4cwNGRedAaoxruw2q9HFKtNp9+vu9BzztHBa+pIs9R7Swrvueob9huzOiKE8omGsPH/nD7eRR+13/tdq5TbqmqwQv8V20ISG3DNlfGNwNM0e5LhC7rF+wF/6s2Ckutw/ZLxjcOm+ItW7WV6PPt5tB/c3Gf6UqaFfcv3CDMuoZtekxqBkDJ1qDMuZvnKHfRsOu4+nz6f3hgNSwjn6pJTLsSQicSZHpwZEB3LGtEj/c0/sQRPQR98kBF1yLTUBRYmxiPaq1DvM90IMfcgde+CVP4so7BWG8Df4xwEdPCGaj/GZyFG3gGt4FX52wOxKNOqa4kqkbpTsWjZrncS2wNoxyNX70SXI53bfQV6FHYe+UZyqeuONv7dQiIq+Q+7Fxts3XXIKiJXdNnQdzZC4MAZ+pxXiv5eOcKhRvfkZyrkqOclf8dZS60CqmXlrz6OFUvqsc60SX30pjO6USV2CFT+qETW6a+F97lfJDFd7P0NSzY6nOvXTmAeq1ZmW0/61qVA557jcrAlnFtag5Mm+982HXLmDvw6XQXmQU5ir+yfPefG1kysaiNap67bbe87fYHmfTMtbuelXaeyuYgGHNXNmgpKqXWUMnWe2QuYnWzqH9lk2s1DVpzSrK3rl56IeEiltbK+Vc281TNoKWjJBsfFWu5TkPlcu66GyX9Kxv5VNGgpaEkM2vKtYdFrmUhTfCygc/ElOt/iAhtXt3rv8lJZkzwQiNMCU9MwA5yMHzstYCOHV2DEAcOIBa4UUNEENZgX2hBG+ntXHjRLu2ztAOlL9y5dXZ69teYbj4mnSkha4f3QJ3U9YlK5HcCPhWJdgdxtQh1DD5ViHMRcfjDnYVPDWLdhn8dtNWZo7Tv8sw8QfL6DN4vg4q/SuiCzhUDrLOFoYvtVz6LGSm4ojqL19k90C3CYEX2ANeqylHQRlkehS6zrmIWl7qwcqphWF9zA0voXyHdykNDkV3Juwe5IUT1moDO4kYQ2UGS10PmrTXzgogTqs+KCGy6OZdEnACdayIAXb5FEQyaOVfY7D8Sd8k54xc66aVmEQ4EV3aRoPmFJR+7Fj3WSWTqi1T2Giv2nNXPRL2dp+6hSyiJSkCU71pLuWDLmJX5R2kWZsVDl1lS2wRQu3W95YKtwSzwj9IUtFqHLsWktgNd4fY1GZXXZRQCi/yjNASj3qHLNalNwVS6M3DzWLrRZC8emmlkuP63uOBL8eB61T0mtYFu0wo4PYCaVcGX1s1ajbTRPrQOUcOXvQIJA1Qo+ki/a8ef5Fk9akA5C89FIZjg8m4D0OKzD5EO5MSIz3RyBlfiV4kMToWu1rnci2fVEh1NdL3iXI5npVKcT3SNYt2QZ53SHFJQrcy1pmOCgOWmeZqcK05mqwkFcZXcm/1XnxKRpnVOz5WoRIwJfc13VQp0qWCISV3HY4XqKOvgkI9yF1unMkvMsFR1qmpwP/VCmNw3A7ukn9qSumFI7/OCk9DjwjqaF5qkzpVjdWvexvMvcDkBe65xwdaeeZnLCdNnpQtgzLrYhQHUZkK/7KPWushkF5kV2Uu/oj/7z5DoPGiN0Uz184fdUMSQ9Kw1u56VdY6K5qAl81Y0aNkqvsZQvdYe5SIhT3IX7TMTB6P9P7xXvLrXflpG2+B2T6JLaNkGWCstdBTzoYSA8GWNqM9g4R8jzDmmhPXPaVg34hQT4xWwT7QnYd9J9kw+dYJN6DGk9Kt4nblmWZOcLXaZZC4zuzJKS51ZHasXZhwnrHiDJEfmM/1kjspdQH0ichNj1mjcBc8ZiZvY8kXhCDBt0Pl7t14thyAjIgy3p73IkOQB4coh4z9gOTJyqJKOz48JL1TXa1DmeSueI14/T9WD4vYcOjAVb9lVcsrtUnqZlfpHahRm5YN2nGVpFkD5bkftmt0B4cu74mkmBf8Y6Wxf3cP/WwKnGHdqx5vmMOfgPRYWozyAoxaJfdynHmSD9ZnTYikeoenqc0X0S2wjHpOjisncnD3rkNiwLRU6WxP3rVlqYw+rmzaxN1L4zu7xRBmm+PPWEwzgKqmReK35Ik0hHGaixV2MhCFsm8gZgpfhJuZFphIUZm1D2pcfvKQ2FdiU/BAlNp9k/gS3YWYSxQuyD5OCoM1Kp3gBdXIqCMp8xAoFUYuB/tGt1/0hglqxJLxIROQq/8om4B8f2XKx6c56TEslPHv9rkFp56psjqly7uoGMSdp9TbVTJNol7K6XtS/usmPdQ2iRBLtfVKwy9h/6dbd5vaSejiV+Icx/VjloON3uVrApG4LU2oIOiaSOfSClvmv3hjmlQ46gpfYHBCVOxvERVvCH6sJHG3fXtT2BC1+ysPFieuSF46hJ17W+EtMlPzq3viPfe9zWERkwZgQ6QLA7jNC+UBHBmqRiANjES/gUdFGGP74IdRWg9RBMrYOmcHnRo27LZ+VkZn4pR2YzrrP/xzlysa0c03kdGo+uFPcG1WJ7I7OqyKxLi+1FqHOL6wycW4wsk4JDtGrVsmuMbleZ6vQGWuiLa+dxH3X1pAUqQtrqC8KK/0q3uv4nPNMwxbpSPyBQY8Riy/KN3gtSRJOIBBoancPgJoBYwZw+orpSdK2RnOSusxaKSgvdaFUq2SIs/ABFu0g/P2CB4xIXxDsAkKgRHX7iN7ugSm1h4d07CA48Tji1q+RfpV58doN1mflGuLMumzthuhcs4b48i1Y443uZGklOejjiO9uu3xYn/AN3xAvfcqNn7L7y7P3L2/ePvvwt2NmX7rdqvsNZneU83L/Eh1a3vOff/zx5fMPr3/+6ebVz+/ePPvw3lHwPEEMAuu0OqjgK79pNJEF2X/3X5LgXKsMYiDNA3kD2T4V2f5cyA6pyA7nQna/uteGpyhsUxZ50OlTs3f9fz30+8Oz3SdbLCqz1kRjOp2hk6GgwOKuVBq3CvQqEcVv7+UcOhjCKV00DC3W/ku375+9fU0NLMrTKpkYhQfG2bPiyCibqvFUn5SoBEXhGZNE4nIFIHNIXuFHJBprrDGH4o40AnBobXNovatdv3y52zmajCF5qXY6LzS4tZo1JKzxcdWvl6FIpkTxGLQQaTs9GP6+333pd2+6e8dQMk8QY5RZiHm7vbvTui0IMtVX3zDzxS9v3vx/NzKI/OXdj3R9xlxNca/ajGjRdZwh2e4gV65fflvtbeTqCGCWIhnDvj88u1/9e//9w/bn3/6zv7UsKowYZilyYPhLt1/dPns4fA6BMUuUBUnf7fpdMJRZqhxYfg6F8XNuBO/7bnf7WTY4d+sE8hnK36269eq/+xfdoXv98ae+X/ZLDxRIqmQsh+0wzr4/7FabT04IunByyYrJG4O4V2OJTghoqkgsQWu/zvKv8E9+81dr7rimrEMJFgjORhRNyDqw6NOZ53oq2R/6g/1aSrMcIr2nBfVqUeGd9OFZ8Fwd8/KHRWVIztP2/U7+zAJYy+18kO+7/f7rdrfMA1nL7XyQu9vbfr//sP2932RqGUaG5wM+mzoloUanVbkh72VU/Hqz7L/lQW1meF5d/+zkLQLV/bMfoZEE/ON2dzcEBc/tJ1oDkIMcs0LXZ6Ng0M2G2XvU9cndUAY+mTeSUrNZS2lJw1/g9N4FI2Seb8nLc3wOBZc8JHsPxKHIMoy93iNuKLYMg2zI0Bps1CyjaSz96ISXYdgMGSxD4eUZH0NGxRgFpg+EQcNfKMRMI57fOJcCLn1oowY0Y6fFav9v++3mzSrBIRpZZFAonOYSE1v7VFYbKVeboV3+uVsud/1+/+f+22Fw4Oub8Q/z7McUk8ANTGEtWQ8XXo4Jn4GSjhp2lgRycMQPzqpGBBNREOP2lbngw6KoNv3bw2q9fH/ofu9/nij8XPXCs440R1B9ftnsz1cjJPNL1On5ulvdndFQeP5nrpnU5LD6Qu7xi6sRku+Za/KwOVdd0JzPXJvboTGcoS5IvhdoYavNp3f91263zDWqXM1yPXMtvqgbZPrn3UZ20Vz1QPJF1vRXX7pDf+56jW71DDU75fxYdTv51jNUz8j8ojX81B/eq45A74eOqx6a80XrdgxeVptP54uMQOYXreHt9v47OYmNjWT1LM9dG+taZb6aXGu//1Q4p5qhFbomiqJm9pv+8HW7+/01QnzFVVXPMHbreIIVjcqtstVq9UjVgQ7yp9zmAnleeLr4qT9krcpj1GE4+ZJ7wAJ5Xt4qmQP1T/jRqYvU5mP3cIudPIuryTG3C9fisAUbiBLroeV3gZrQlOBXeTbInxA05b3pQHUEyZsMBKUYqQOJQFDBDDSgE5zf8qIdqJktNcDebZf9OgfiKaOoIC8G+e/YAmk47t/BQml+1JFewA0d9QDZER+PzvqM827QZnZnxL3vD+gaejjkY05nRDu+jbv0iUDciI3czo+aegw4GrjrieAc2F3PPEc4bc/HnzP1yhf9/rDaSKpgFH62WY5TgUw91VHExbzmbbd5v/rkQbd4GOmY1SXa1tIjAA9oWMsAniER97iTOjP8U64Xazv6O/FZq0VlfLGaaZxvtqaG5HmxiC6AyXJX5BwsVkylfBgsd22ysleR400Ac+U1uGRgrSJrkq0Kl8YexlT5hVvpLFWkFbwZKi9TJLNTMbXwZabcNUhlpXzRkzyOk7jxZmp8OZrrKDomA/9ybUYnEVTLdbaR7Dpi0EpB5jEcXYeMPIFY4seUa7/hIxFPDJCMCIL8+7WfK0/UiK+XnqkldEePC4unr712udUUDN7snYkimKjDcCCe+3510xs3Y8x99yTi773fviZu25jnOcn6evAjXsrEu+1dXOFXelJfGMcsksYUAlDYsGKDZPjvz4fD/fOtda5HANJSZkPT3a/iwJwS5sTypt/vu09xcE5pUxCFegsCT4DDsOpH69e/bFZ39+v+rt8cyPt05rDmqR6lrxMwiF7vFzhbMs/jDyjQadv7/WBH+wwKNOo9zoY4wK9QgDEPc068Ab7HAhnzQjlRR/snCnPCLgRPPRs+rHs4fN7uVv8d5MJAokfyYBiKXA4MqiWT/0IhZ3NfNOgE74VCzuO8PPEG+S4UbhbX5Y82yHNRgLM4Lhpzgt9CEedxWxYda17rp+3h1fZh4++xjASP4q3mCPJ4KlMVWbwUAjWTh6LARnsnBGoOz+SFM8ArITAzeCRflAHeCAeawRNRWKO9EII0hwcidap5n9cbuaQ77rl64e0CsHSP4otIIHlcEqqfLJ6JBp7JQTmgR/spGngOdxWCOsBr0aAzOK9AzAE+zAo7gytzII/2aDTuHI7Npe+5fxsJ83AHZyZ8TA+HIMnq4oCKcvo4DHpeJ0eCT/VyGPSMbs4Pd7ifw2Dnc3TeqMM9HQE8n6sjsaf6Ogx5RmdH65yK5uJCqEf3cxDGGeK4c0VxZ47hzhPBnTN+O0v0dsbY7VyR23njtvNEbeeM2fwjtsgo6dG92AzHOWK1s0Vq547TzhSlnTVGO0+Eds747GzR2ZljszNFZmeNy3w82t32YRMclWmpHtWfARh53ZmmmazeDILO7MxQ2Mm+DILO6crciCM8GQSc0ZF54Y3wYwjkjG4MRZ3sxSDmnE4M1/Pch02nV8OJNJDyMX0ZBiWrP4NayunTUPB5/RoNP9W3oeAz+jdP5OE+DgWez8/54w73dRT0fP6ORp/q81DsGf2eRe9z3/e2+9SHuppjmsf0dyaIrJ7upJOcPg4AzuvdMMipfg0AzujRnGjDfRkAm8+L+WAN919zuPk8F4Y41WcBvBm9FarfuZ/6cXW3Cp5mnhI9pqcCKLK6Kk0tOX0VhJzXWaGgU70VhJzRXbnxhvsrCDefw/JCG+6xEMD5XBaKOdVnQcQZnRauY/1E4XrXd8vv6s1ib4cxT/UofouAkcdxIZrJcxKRAJ3JdVlhx59WJEDncF7+iENONBKAM7ivILwhpx5pyBkcmBV1/MlIAnMOF2bXs+bD3nTr4UGofjle8+TtP9CEj+LJaCR5nBmuoiz+zAI9k0tzgY/2ahboORxbEO4A32aBncG9haIO8HB24BmcnAt7tJ+zIM/h6pw6N85Z7h/u77e7Q798tt8HbDRDEz6Kt6OR5Dpziako07lLEnq2s5d28AnnL0noec5gBuAOOodJws5yFjMMddB5TBvwLGcy7dgTzmWSyPOczXToHNm9MchFnB/Qkj0mszbDkXcDh66crDs4ZrAzb+HAgSfv4ZjBzrmJwwNzxC6OGeSM2zj8EEfs48BAZ9zIgeNO3skxQ51zKweh67lH027vDvUmMOljejYUS1bvNlNUTg+Hw8/r5SwVSPV0OPyM3s4Xe7jHw6Hn83oByMM9Hwk+n/ez4E/1gDj6jF7Qpvu5J5zuCg2O7syEj+kFESRZfSBQUU4PiEHP6/9I8KneD4Oe0ff54Q73fBjsfH7PG3W41yOA5/N5JPZUj4chz+jvaJ1r3u5dv98+7G77l98+dw/7kHse8ZSP4u8sUPI4PEJLWTyeDXwml+eEH+3zbOBzOL0w5AFezwY8g9sLxh3g9xzQMzg+J/poz2fDnsP1ufWu+b5X8qZvuRnlXd/dfg5wfkTSR/F+Nix53B+lqCz+zwo/kwN0VyDaA1rh53CBgdgDfKAVegYnGI48wAu6wGdwg2780X7Qij6HI/TQ/XzOO7xy1y/fdt/X287fF5KJH3PuS6DJOv9F1JVzDkxVIe882FqJ1LkwVYWM82F//OFzYgp+vnlxEPrwubGlAvnmx9Y6pM6RqRpknCfbbUCfd31/6A4PwZeRIKkf009ScM5y9lXX2DnOv84qcZ4zsHg1cp2DnVXiDGdhPWoQfx52VoH8Z2L98Mefi8WqkP9sLF6LXOdjZ3U4wxlZwg76TeaKhHzVd4eHXa/tsfF2VPYcHsV3ekDKdPm5XXtZfKhPZXJdj+5bnfj70j0qk+UC9aiahNyo7lGRHFesx9Yj5M51v6rkuITdtzbxt7J71CXLNe3eNdG6/ZTLsNvnWJn5+37DZ8RtEifxjMzmmpGZPSOyROsoM7R44TfbZb/2L/FKT+NTtkpLIugPt59DSh/l00u+363uut33F/1mezduUwjAgaT+E4vFFT6aQDiOAcP6HDwKKfitXIgIfyc3FoEUCSr/lCK99Nvt5rDrbo+PNQfZBaRMR7Psb1d33ToEhpbkf2HHyYLqsH122N6tbtU1WgGAZgkzOLXd9i4SDZI0h26cI+5cK97PW7rL/9QfngV3YCNRHAZkrH44fO43h9Vtp/vX+Ziti3mP3c/H5M/QQuY1NgpBE/uO8UaBKeOKJ6TAp3PduVoi33/vv2cAfMwobGyMRz5mmwe9kdkZa2D0Wi1pP55IzGEINNesLcioxW8Pq/Xy3/7xIQN0Lavz4e2/yYDhbX+Xp+nA/C7VejZb+5P0vvinfM6Jez5O/NatOx3/bIQYBbzHhr+ADGcKmTL8C5kxVtEJZ/z8Dis3ZI4H0juRPNssnbGAHZORQzQ6c5hxhGkooM4zQPPFEKUV72lOCIoYDEktheyAN3fdvbMTDkKhHfGNli9VS5nvST6sS0rkls4w5muZxVlQXIEc/CFpOZHj/tLdCFFQKmFWLO6Ziw2Q/yTGjWreRKcfdPucfgTPIOjqHrN8TueNVfAI1k7xWJojXvKVltATwjEDDUtdVbw+grm5OXy/D1bCEcq1Sv+nIgLT9bE+hKL+0u379/39dr3q0gFem7lFgx0ztGF+0602G5trD8J8yu1cmF8ePve7/uEuH+55jufG/rftut//bonig7GfcjwXdjmYh7uBY7LHdgIKyPUxdbCexprQpk2DdK1yiITlMN4/+lUiOpXDedD99WsyvDGL8+D7Zb+8TcQ3ZnEu6yY3vjGL8+Ab1sfXq34T4z70pAkuBCEP33oQcTQqmEEubA/DuL/70u/kbkgLJUtAm6dPQGaE3LfbzcfVp4dd/2q3vfu3vW1xh8CG5ZAL3Wa7u+vWq//uxxX78LF1nkEubIetk9kgQOkpE9AE8/20Af3ZfW/1fOoPL/qP3cP68Ms+osXPkqfgwmZzm/2h030XMp0bRazzOX7K/K//ePn65sXL56/fPPvx/THfL91u1f1G5Gwk8Z7bTdBRFEOOb1++u3n54W8v3/mhMJLkQfHsw89vXj+/+eWn1x/ey7x/ef/iuR8aNGkCKsT6cheQxfTqu/c8froH6O3rf++/vxo8jmUCM+aNpPGs4wieGGlevHz17JcfP9y8efn+/bO/vozGcTXPyAsXlmGKz3LBDHJeXhCN/Vm7Tw93vfMJwTFfQ/pRrDlHEG1Hs+rpFkSgxdiOgmX2x0O/23RrP6sZ0o/UByGChN6nVz1Hv5tBi+txOCzEiz4fw0nHTiOzKxuJHtOPzoGkOlJTH9k8KQI0wZVSIBH7/rLZ6yfCfPGCZI9pYwxKqpWhVrLZGQWbYGkaKBJnfZTHpG8Ow3mW7tbo0LOYay7rHX+p09gfkFJmykFKmaX2bFtI5RKs5g0szHg+2VLd486+lcAf8d1sb4HHpo5A5HDuqUn9rdtbiDT/aqC55tW/pRY/rjYW+iO2FmOuZ6yFe03XH7v/Cm8o4rnv2ku+7WZvEnYzt2WIeXssPzLQzFtP4+mizDo4iZpoJFdGHiGgjLwiHZELXJT78UIJ9WjjAj1U6EMIRuH6R7deW5f5PMCd8siO0O0iXPj8HYMfOsQdHLrfV5tPN9v7HkxN5i4Bivq7BZXy51kZc4XMyoBpfV3ErF4JQYwnqrAQxp1prN/wRBvnP6JRa2OWrcd6gge5na8OM1/4Ih38lE3OFmIJsTKoe57hObGru1X+vl0/bA7dbng17TCe881TFXv+Z62ZvPogTyWmrM6Gd7X/0O+G423roSzLJhZf1PMMz4b9a7eyxX2egMdczobScW7YF6bnceJ4nENYkQ5zzCUrSjqi2fVfu93SHc4oudBY5p2ZO6mTMXcjVWAIM1aEMM16ZTvQ5IRxNaYPwmLmkyOyovFFxVQOmDHRFI0wKY4KQdrZTzW4kXazIw5nQvrRsVjshnrM4RxYzYMCjlMzHmr1PEITg27pNfDS2JZB42yQ3tRlAFZuwK06LZMzYPSYgTshBszBPRHOx6zDrltaTmDIz94j1Acjs1mNVWYfiCyxeil0CV4eFhnm1LXUkT58Vn6Uy/bAga0IudGYqXJj6u7vd9svvdcy0gwamjgDwhCGcQbKk1L0K/kn960wGICf/C+G8cOheMhQGFqqLCieuZ06BuOZvxv3wzHsuXVuQ8WQmAnzYXEECSQUz9DAD8kH99ZcDMgH/3253jgi9KGlyoMiyqPNEubpNylOlkqfBZmLccLQ+FJLHgjsPMyscD/CxaPcXW/fhTMr+ZggvWx31DkPAbyDTKJ8NKZ0706J2Zbi28iPGYfvQcm0+cQGIjgGxXKKj0dpXLGxaQi+Xfc1Ep1KeU5sah9WJLxj4swIoVf13u1nRYtmlNwS8dWUZKQwm+w4vbc2uZAG72aK0Kl7VLUr03+EDUEm793zCuFpdDCPvAi915SsGIMXkpJao32LWkBr9NuVFoh1131NHpGvZpnkxWhfP3J69DO0wvcpo4yWPC8ur8iRxhUURbpwERHlR9uuwUkiLJb8aNsseMzyA503WcOP9OYsj0vF8KJDrhWb5ZASMM6RxIeKPph8yUwMWRqlSeILpA0xZP7koTcKPwqRABNGJHpj8qITCUhBpKI3olcBsQkKC2aQEZv2yHsSRCKfjEh9CEACXAgJ6I/HTQRScPzJQG80YdMyFFbchMwTX8hUDEUXMwnzxBY2/ULRxU28wvElYsuIaz+ZJAUdkUnOduczXcUbXMhENdySHlMrlzUDJlU++DyIYwxTAH3sh8NzKoCEXmGTAAoLEv5/v+8tl0vIz9bAny3apqi0yzSGAenZ29fqzqRjzjIjmK8p6zsHkIhPAKxXs/kWe+V7KRuWg2tkj0VzrWUQAet6diUWtJVccHg2vxoLxQmEL2YtrNxAc8F6Evb6bbftlrfd/mButglFdT3LJwYkZj39Kqxd3x36RKBmJmdAqZx6CkQthzPgG/bJyhQRbX9CaOSRC6PZT9XczdOpAuGL9VOs3MB+CutJcBiq2SrhaEzXIJcYgHPLZVWbAfHa/+ZgG1az2oSCj3RBPHQ9i/+Nqj3im/TKE/V6qrDF1yiJ2f3qwejRvPKoGeec4BsR8fo+5XQGvCe9ZFFuTq2CKFkRSb5xMpC+XKSMFRwaK8OqknM0+eKOuvng1cNm6TChDds1mlkUXHcPgU/vhaM1MjkHyqFJj0lcbscKFOZzXo16OR1PxQa6nXj9+jl3Xy2HuvdA3CoYSG/AMJ9sWE2v+fKbupktzHtSqS7mRa0AAr0pqQJLywRp/FqoD+hre+5JFXJ7CbzgDLWy5X3OOo2D1pTaeyT0qpQ18+y1MvvtcCuyZ2c1RC/WQ+elBnZLs4Z0m33+sBsyMG6ZDkN0PcslHKDbYsMxt97TZKbsxWyGFBtoNFBJihUcnlYkL7sJhHZN5RYB2N9DZkNvz/MsdRjLeb7dHPpv4S1RQz7LKT9eeWeDcUTU4botiPG8MmE2e/vfh8syh5cnPXv8XP5ivZ4oOrDnIxW2xE9HaYcx7diuZ1lFQnX3mWOaJLwgo4xoZ6tQcqHSs/HNxC+5EoWUHL4WBWrrsRplbqcMB3eNZRYH13ddKhnyLKez4J22HSSCNbM5C9JxnUmmcS9XWbDCjPKhBTGkdl+hbyiJJblcREmWHhpYojW32FVP4IoYXCCvsQzjYXtw2Z4bCB5h70DatgF0xwB8KsvhNohF44eAqZttpdhA89VjzY7A8zVorc4bUefFLOKQukA20RfT7MBDCKhDoJMPQeXaJkFD8t8e4Y1nj136HAILZJAZ3TDBiYM1psyL54tfwE1g+hIaZfv3P4/tZ0TvC9p35ounNynEKGTzPJIxzo8ugb21/ebhjoyylGzkmFacBrS3L3968fqnvwYXenVKGBTKjXVEsfzl3c/PXjx/9v5DOBo9aTY8z39+8/bHlx9ehsPRUmZD8+rZ6x9fvgjHckyXhgS9tcG7xeril2y0s3Kj2q1R2eSmO8cU13rdqAIa8BxUVBt2Y/JuxnNEES2ZwIPvdXzRHTr76HCSu/AOx2ORUZsbZcWs8bt2DiwAxbWWOBCOMxLs4xCNCZPRzHmFfuluH5PUBdkDrcBgwmCsUrQNsNKDLHDMwBHBbW533+8PUXD0tDkxdQ+Hzx+6TxGITilz4ll9iYAiEyWimDEz5jlOPMqWMpG9BBaoHZW1l6oJRhaNv0/kEwXN5S8UBhEFh8ZBSH1RTM+ef3j9d0fAQUE6pk1HhA/wzyW7//P9wXjKwjK8GAkuPOTPy44a+806E85jM7t3IAbY9SbgBgIyQwdltbrrtw+H9/3t1rlFyQV3lteZMK+Gt12/dOssoOeZ5UMNe830UrxXjwHCF+stWLmBPQXWkxry71f/3n//afhPLKJrI48YcI62Nt6H8u/993iMRh5nwPiw79Hn/YKBzjM6A9pl/9vDp0/6+elgnHoWZ0A4SL7tDp/jAWo55MFHeZLpGeR+uILl3/bbTZBroVJf3NdYgUQ6H1I1hNU/rtYBVvdBfK1lmQX6OfyAV0USHUNkfQI9hVdNol1HZB3CfIlXFWKdi38NzDeVJq803KzmmIgA6fQp2fjIeUSxV6ek/tst9ZriU8Rn7z68fvZjDJ5T0ox4fnrmMT1E4RxTpqKZDU3Gli+/8QhLcrlBiCw9dORBa04Fvx60jhPZte8DR7b8PFafXRNZD6DeV5xFI1368lZutGZWZ0McMvl2g46bfsfgDpqAu4FHTsE9kSP3JRk7vmbXJQ1frbcl6dekGoeAZhdByax+wfPDKiaBnQoKvlbfLC/sIv1jWsrqjptQQdlRN6BiGJCdyeBeC6cagi4JcWJw3G4KCve81dRZKnYrgqvsoEsQfOodqPiA+0Ocpa/u7re7UAAgUSoG981voHz/G9/QshHPdVitLTe9yc9W31Xr4+W6O7FaHx826gVpmJsU8/VfEh5a2n232/fULaBk4ViqdCzr7adn96t3/f5+u9n3bhSmfHr5u/7Tan/od8++rbb718Pod9vfG0eTSChk0nRUt9vNl353UC32w/Zv/Tc3nHmaSBxIW5/vx5y196OI93g9P1U168OnTP9uyR6r1AmxxYmHF+z5EjCS3HrEMQKI53PWdiTBUQ0JJyi+sYMKiXRIPFExT4DZ9MN8thCEBDjLIF+T8rjL1gbL9zbbAETu0ZoE5D9uO/DMvRo43zFzaeq7tz9zBURjdv+gcsXq9NV6r9ybZ//vzbMXL969fP/+5fuQgq9gSi8Y174XslkaHoIlKDT2QuLwqQgGT2/qVbqKdIOKPybJUb6aYwWVf0ySpf4b22uGWO03Pu8ZUmWHDBdI4VEDhR+WbogOw8BMSfKjMbY8+mCZbXbMhaSbXZzmA0dPdTZMw1rO213/cfUtBpuROgtGo1/134L9yjFJPr8Cjxr5uxfvA0ZeaIb3AMKb9JQmBwLkqkIfECGXE3qPu/PLCH1H3oDrBwNaiXlLtX8b8byb2lsvs7vZfNXif+2ab1uB96l5thXvq9J8cXg8xIQjCXiEyReLZauxJyg0h0zowlWUTTf77ksf7t5OibL0n223DMagJcpkhRf9x+5hHetqZ6mz+Lhu8976WCPm345pssxw5HWDYVOcKUlWL+94mNDm6D0P/nvhcRMMCBJ/asELw8g/hPdbkDB/5CivmVsN6+ifhjKCOxFMfB6E6jTTarvRd/j6IgSJ8yOUFw2O95JHuCI0eX6UX7vV4dUW7jr0AQhT5se27w9v5Pz2p21gbAhT5se27HerL31ow9NT5cc0zpoOh35/MLfSBMy5jNT5MboeAkOAIY+ApaDRaKeltkw2kbnyr1YKtyzaki9OVADs3UdaWLsZyhlOwBuqiELG4P5HfS3KUp4pnla0b5mJhRkXpqDF2C9GcRUAZ1VYEc4plLMQ4wGqd+rmZ3uRRIoMAGTYFIoBJIqFgV226wXFnjASznOdVvKBQSRIKl6fgPpjwFMlAfFum6h4atHerZJKkQRADQv+xUP5fIWDRUBPCK5tUS4gLw+f+13/cHdc+HzTH7qlfqcDBsSWKhKIugYfe+cVA4BJxxbcd4eHnX0cOMlEFzK7QpotFrPNS3jZjqT5IPl0A2uySCh/hVeC+wCxJIqEMZyJWL/c7bDNSlrBhlhkUT91h9WX/uXhM3GpOlYunSYSxNtud1h16zAUlkSRMAZuQHq21Xbz8ku/sZePSecq+F2/f1gHFn9MEw0COeyHl+xzdi+kOB9lz6VzFRxRem4IzpkMlSIDgKCyE4tdfdrI8Sugl1FJskLw6W/2hAlw+uXft+uHzaHbfX/5bXV40+/33afeK/zxSh4Lzd8VZ3PARj7hJecCMH8VxVK2x3MnocWqVcCXm4e7IABGskxQ/JohnSgNhorrfMo+SuYocFBk76v+eZIcEF5td3edV9sH8pGFm7sdsOIc+xq8CnCONbpUfEFeM7csc7bZNZbOVkOlSAfwQT+b7Cj6g/UgslehHx1hont51LeYEM1C8cSifRqsLhhZ3C/oEVKtGPu7bq7s58dUsDI8XvbxLuhFf+jQs2VYeSfh1GKd5oKSkQV6UGSpfJhKP98b5OwGjoRJcJz6NcTSVnf6/bP7lTyY9rbbdXcy7Ha0YFfKDIBe3XsjkKI5iuyGI0nf/cs9ymcoXB4K/Ng5lqeoFBkAeJebuMIX0dpsyVKhuNqZIZdcmE8LmwunFuvZtjDx1KL9SkxYzTBfpIjwZb45ZAToaHNkkpwQPFqiPV1GMH7t05UyI6BgHHkYwvDG65M6EzBHo0XFcxXt0VjpNJlA+DVSW6pMQILKT2NJ+vAGaUmVCMTVAHWx1KJ8GtxMNrFQzwaGSCcW7FVeIiEV7tqsyVKhONqSKZdcmEdrQoRTi/VrT6h4atF+JaazRlGtypoyAyB32zJFcxTp18IQ+QyFe7czNEUGAN7lpvGG4Y3NlioRiKORGWKpRXk0rrlsYqF+jQqTTizYq7wMDGp4a3ImzQHJ0a7mslkK9WhhRIIcxfu1NTJJDgj+Jacyy+Htzp4uGYyjxQHB9OI82homnVywXyvD5ZML9ywzYXvzeEu53JYgm0h/0N9TRzc3k2lygPAvOqVAdeTIcpToSpPBS1GHkYLXwLQiHEtgrgKoU0xaCa5DTM4i0LM9egHWoz2u7KmTPVoBroM9nkW86ebual6Kkoor6K//ePn65sXL56/fPPvxva0sKBjZul6+vnn78t3Nyw9/e/nO2siAYGRD+PDzm9fPb3756fWH9zK7X96/eG5tGESCuOJfb+QB6mdvX/97/53Y+qMVjotH1nz36eFu2NKKbjfXawwEY2uqWGpncVAwSbF2DzzXrJ8f9iycuqaWLn6eIg6A+yiLVrb/SRZXsdad5FqJXhvJXYXhG9e0Uuz71jyy91FeDrWRu6pgObZNVV4j3rO3r9XD986hT5dMsM+z+5XKxjqaz0VTIhOvSs5Fk2IVP8XOZeMKBSt+XoVb0sSBGLgHr5KhYKRvkby/T3kzybgCj7Ncr0JR6TR34FUuJpzuvP30TCSI7EheniKDkzB3i/ro1nE3V8BI4lkmEE5xhi+wLfwzP/jCtmff3XDAG+xoWznKRDYP850jrGnY3zByFYA9V42U8sLjSZ+QnuZuEQG3xPk1Cfy5ZbJtQPG4oqk3ay0ERa4inY9bWjBY0iYMY9hLeNRAZspGasL6lhpWfSJBfKTgChByxUIBIVBqmOkukL4zK7TJWM+mgSbjdTTNs1DiHNa8RMcxrLG4/3g6/vrhn0++9Lv9gPCHJ+yaX7dPnj75uOrXy/2TH35VIJ4+ud3eDcTDk/8Yv/29v5XPm/zwqxL58+LJ018XT2txXS7Yf/zH01+nFPKD/IMUK548/bV4WlXX5aI1xApDjD15+it7WrFrvhCGGDPE+JOnv/KnZX1dckOKG1Llk6e/lk+r9rplZpmlIVY9efpr9bRsr9uyNMQqQ6x+8vTX+mnNr1lritWGWPPk6a8NlltjiIknT38VmJgwxNonT39tMbHW1O6g7GKBKa4AdpCGKLB6FKYpCkbVpDCNUXCqLoVpj6KkalOYFikqujqmUYpB+QVD8zTtUjREmylMwxSDAQqOlm3aphhsUJSoKk3zMGmeCuslzDQPk+apsY7CQE8ZjFA0T0tx3YIaMdM+jJM6YqaB2GCGQmBdhpkWYtJC7dOquS6L2pQ0LcQGMzDUQzDTQmwwBEObJjNtxARdumkjNhiCMTRP00Z8QfkU00K8INsHNy3EGeVYOPBmgxUYx1TETQPxwQoM9WncNBAfrMCqp6y+LqvKlDQNxKWBUM/GTQPxhnKo3LQPH4zAGrRCpn24tI9ACzftUw5mYC3qzk0LlYMZONriStNC5WAHjra40jRRKUcchpYOBp2S7JelaaJysANHzV6aJioHO/ASlTRNVEovV6E1Mm1UChqnaaOyJXpGaVqoWpA9ozItVEkLoV6uMi1USQs1WH0q00KVtJB4WvHrhoM8TQtVgxl4i+YJIoOKqHll2qcajFCiLa4y7VPJLoS2uMq0TzUYoUQ9V2Xap2qpblmZBqoHK5Rog6tNA9WDFUq0wdWmgerBCiU6tNWmgerBCmWNSpoGqmXghrqP2jRQXZHDZQ2iN2kigeZpmqiWJkIHl9o0UT3YoVpgmq9NE9WDISrU7LVpo2YwRIWavTFt1AyGqNDu1pg2auRAVGJdozFt1AyGqCpMn41po2YwRFWjeZo2amR8jXbhxrRRU5OxM4ixGyribEwLNYKKOBvTQI00EDoONaaBBBUnCNM8go4ThGkeIc3TYk1TmOYRgw1q1M8I0zxisEFdoJKmecRggxod2YRpHiFnQBzTkTDtI6hYW4BJEB1rC9M+oqViKWGap12QEVJrGqgtyAipNQ3UDlao0UC/NQ3USgOh3rA1DdRKA6HesDUN1EoDof2nNQ3USgOhjbg1DdQOdqjRIbA1TdQOdmgWqCSYqg6GaFAf18LZ6oIEqr7psgUJVX3TZRkJVn3TZQd7NKijVd902ZKiJdQnXXQwScOx0UN902Wlv8MnkAswe100NAQwgV0ICwQwhV1Io6ENVn3TZCWT0KAThWLGMhTk8FBAnkHSCXhkX0CqQTIKDRoaFJBtkKQCHt0XkHCQtEKDt0hIOUhigcILzCbJhQb17QUkHiS9IPDWC6kHSTAIom7AbpJiIIgcYDbJMeBUDoPsECPJHMA/FIqAwOkcwEAUkmcQeLcEHEQhmQaiYsBmkmogKgZMJrkGomLAYoqHICoGLCbpBoGOngWgIgpu6WmAjigk6YA7BsBHFJJ2IBwDh5wepwbcAnAShWQeBDpZKAArUUjuQeD+BvAShWQfBKEFYDRJQAh0kCwAOVFICkLgfR3QE4XiJ3DtAqNJFoLQLmAoCslD4NoFFEUhiQhCC4CkKCQVQWihhFystBrumQBRUUg6osU9E6AqCklItGjkWQCyopCURMtwWWA1SUq06OS1AIRFIYmJFh9YAWlRSGqixVskoC0KSU60uC0AcVFIeqJt0OYAqItCEhQtyl0UgLwoFHuB8dgVJNHJhY0C8BeFZCladM5bAAajkDxFscBbAyAxikp5SLw5AB6jkHRFsUDnIgXgMgrJWODhewHYjEJyFsUCbzyA0CgkbVEsSrTTA06jqNXQhs6YC0BrFJK8KBYoXVEAZqNQ1AahjBqugshlkAXe8wG/UdTKgAK1NqA4CsVx4OsrwHy1Mh8eqgOao5BkBk4/FoDoKBq1ZoXOewvAdRSS0cDnswVgOwrJaRRFgQsD60lag2hwgPIomsrShgDrUUhyoyhwN9jAVazGBhkYT5IcRYEHHYABKSTPURT4OA5IkEKSHUWBEs0FYEIKyXfg/FMBuJBCMh6oewNcSCEZD3xoBmRIISkPvBEDNqSQnEdRoBPzAhAihVCWw6cjgBMphLIcSkEWgBgpFDNS4MMz4EYKSYEU+BpbAfiRQrIgBSueVsX1ogK9H1AkhSRCCoY3TcCSFJILKRje2gBRUkg6BI/dAVNSSD4Ej90BVVJIQgSP3QFXUrQ1HbsDtqSQnAipM2A6SYugLRgQJkWr7Ib3OMCZsIWyG9rjGCBNmCRGiAVSQJowSYzgLDYDpAmTxAjOYzNAmjDJjOAxBQOsCZPMSMFqHARYUJbUCO6IGaBN2KKhHTEDxAmT5EjB0FGUAeaELZTx0FGUAeqEjfsz0DCBAe6EqS0aeJjAAHnCCmbRHGBPWKF2AqAjNAP0CZMUCb6+wAB9wiRFQskC80mKBOsfDJAnrCA5Lwa4E1aQYQoD1AmT9Ai++Mjgvg1GRykM7txgNOHPZns3GL0lA+7eUOwJvp7N4AYOtYMD91QM7uFQmzgIlwK3cUiahHApcCOH5EkIlwK3ckiehHATcDOH5EkKjgY/DJAojNMTBAZIFKY2dRBuAtAojDNLzwc8CuOWCQIDTArjlgkCA1QKk3QJpQzApTDJlxQc3wgDyBTGyT1sDHApjJP72BigUhgn97IxQKWwkt7OxgCVwkrV7TiqM0CmMEmY4BNtBsgUVqp+h47ODLApTO364BXaJgCdwkplOTTGZIBPYSXpLgGbwiRjQjggwKaw0tLrAJvCStXr0CiXATqFjZtAUHaNAT6FVcp2+HgECBVWkfsRGeBTWEXuSGSATmEVuSeRAT6Fqd0geOMBhApThAohC+xWUaulDLApTLEp+EYTBtgUptiUEqVeGGBTmGRMihIN9BmgU5iiU0qOeh5ApzDJmBBuGLApTLEp+L4TBtgUptgUfOsJA2wKU2wKBRnuWJTOskR5PgbYFFbTzhJwKaymnSXgUlhNO0vApLDG4iwBk8IUk1LiES5gUlhjsRxgUphiUkqBowCWszApDDApTDEpw3YcLGNguMYyMwBEClNEyhCkIF0UEClMciVUxsB0ikepCjxjYDxhCVIAjcLUjpIKD4gBj8KExXiASWGSLimG8B1BDLgUJizGA2QKU2RKhRLxDJApTFiMB7gUprgUorkBLoUpLoVoQoBLYYpLIZoF4FKY4lIIUwMuhbU28wEuhSkuhTAJ4FJYq+yHx/GATWGtxX6ATmFtZVEzIFSYIlQINQNGhbW23gcYFSZ5E1LNcMN3a1Mz3PO9oNXMAanCFalS4TulAavCJXNCqI4DWoUvOK06DngVLrkTQnUcECtcESu46jggVrgkTwjVccCscMWsUKoD+8EVs4JvAuSAWeGKWanEU86uywbsXQfMClfMCqFnwKxwxawQegbMClfMCqFnwKxwxawQegbMCi9Ki54BtcLVWRhCz4Bb4eo4TNVixxgAu8IlhVLUi6dldb0oIQpgQHUqpi4GJmTBYc7AgOpgTI1ONjmgWDijR0AOKBY+no7BdQE4Fs7oEZADjoUrjgXf4scBx8IZ7UE5oFi4olgoxMB6imKpUT/OAcfC1WkZAgWwntqnQqEA1lMkS427OXhoRhIpVM7w5IxiWfCtjBwenlEsC+EFZgdouA0GsJ9iWfBOAk/RKJKF6CTwII0iWYhOAs/ScNX98KMv8DwNp+NPDk/UcGW/FtcFsF9p6X2AaeGKaWlwhwiYFl5aeh9gWrhiWhrceQKmhZeW3geIFq6IFnyTJwdECy/p+JMDqoUrqoXQMeBa+HjShtAbsJ4iWyhdAOspsqVBV9w4IFt4Re935oBr4ZJQoeoH2BZecUv9AN/Cq9JSP8C48ErZD3fLgHLhVW3DDAyoNrFQmIEBFe1CYQYGVLRLgztxQLtwRbsQTg7QLlzRLkQFAe3C1S4WooKAd+G1rQMC3oXXFvcJaBde29wnoF14bXOfgHbhahMLvkeSA+KF1xb3CZgXrnaxNA3GJ3PAvfDG4j4B98IV99IINGPAvXAL98IB98IV99K0eMbAehbuhQPuhSvuReBtCHAv3MK9cMC9cMW9CPQ+AA64F27hXjjgXrjiXgTDMwbGs3AvHHAvXHEvAve0gHvhFu6FA+6FK+6FaG6Ae+GitDQhQL5wRb4QzQKQL1ztZCFMDdgXLmzmA+wLV+wLYRLAvnDFvgjc4QP2hbcW+wHyhSvyhVAzIF+4Il8INQPyhbe23gfIF96WFjUD9oUr9oVQM2BfuGJfCDUD9oUr9kXgYxRgX7hiXyjVwePcrU118ET3glZdCdiXUrEvuOpKwL6Uin3BVVcC9qVU7AuuuhKwL6ViX/D92CVgX8qRfUGH9xKwL6ViX3A9l4B9KRX7guu5BOxLqdgXSs/gsLdiXyg9Awsq9oXQM2BfSsW+EHoG7Es5si9YlFEC8qVU5AseZZSAfCkV+YJHGSUgX0pFvuA76ktAvpQFPQKWgHwpFfkiUNqqBORLWdAjYAm4l1JxLwINEkvAvZQW7qUE3EupuJcWbxeAeykt3EsJuJdScS8tGnyWgHspLdxLCbiXcryjBJ39lYB7KZnFeIB6KZnNeIB7KRX3QhgEcC+l4l4oJQPrKe6FUBzgXkrFvbRoAFMC7qXkFvMB6qVU1AuhDEC9lIp6IZQBuJdScS+EMgD3UiruhVIGMKDiXvADIiXgXkoubBUEBuS27gdvNFHbXIgKwktNFPtCVBDeayIZlqLF7wGBV5so+oUYpWa3m5QWbcALThT/QmgD3nFS1jZtAAsqAobSBrCgImDwsQTedaL4F2IsAfxLqfgXYiwB/EupNrvgp4dKQMCUlaUHAv6lVPzLcNQI0QXgX8rK4kAB/VIq+mXYxTLfTFgC+qWsLA4UsC+lYl9avF0A9qWsLKMfIF9Kya+wBboZogTkS2k5QVQC7qWU9Apb4FcFAe6ltGx5KQH1UtY24wHqpVTUC2EQwL2UinshlAy4l7KuLYoD3Esp6RW2wAdWwL2UFu6lBNxLqbgXShnAfGrfC6EMQL6UinwhlAHIl1KRL4QyAPtSSoKFLfCBFbAvZVNaKgjol7KxdT9Av5TqEBFVQXhJVGOrIDCg4l8W+GAJCJiysazdloCAKdUhIkIbgIEpFQNDaAMwMKVgFm0ACqZUB4kIbQAKphQ0+1kCBqYUFvazBAxMKSzsZwkYmFIoA+LjO2BgSmHpgYCAKYVyoOjFDSUgYEoLAVMCAqZUt60sGtR8gIApW4sDBfxL2SrroVstS8C/lJbNLyWgX0rJsLAFulmgBPRL2VpGP8C+lK265xA9QFsC9qVsLcYD5EvZ2owHyJdK8iuEQSpAvlSLglZyBciXasFoxVWAfKkkv8LwC0krQL5UC9p8FeBeqkVFK6MC3EuljhRRygBXuKmrWChlgFvcFsKmDHCRm6RXWIFf+ga4l6pYWCoIuJeqsHS/CnAvlbqQhaggIF+qglsqCMiXSvIrDD+QWgHypSos7FkFyJdKkS+UNoAF1cEiShvAgop9obQBLFi0Nm0AC47XwmJjSQXol2rc+oKOJRWgXyp1vAgfSyrAv1RM9UB0fK8A/1JZ+JcK8C+VpFhYUaGKA/xLZeFfKsC/VONFsehMqgL8S8VoB1oB+qVSt8VSiIH11PmiAr+bEtAvFacX3yvAvlSKfSFQAPqlUnfHFug2kgrQL5W6PpbKGZhP3SBb4PdkAvqlUvQL0VcB/VLxxgYD2I/Tk/cKsC8Vt0zeK8C+VKVl8l4B9qWSBAtj6JhdAfalsux9qQD5Ukl+hTGUyKgA+VJZ9r5UgHupJL3CGMMzBuaz7H2pAPVSSXaF4ce8K0C9VKWl9wHqpSpbmyqA9SS7QlUPXjertr4w3MXBG2ct1EsF75ytbNaD184q6oWCDG+eVeZDI/wKXj+ruBcKBrBf1dhgAPsp8gW/HbqC99BWlslfBdiXSrEvBGZAv1SKfiEwA/qlqumlowrQL1VtWTqqAP1S1ZalowrQL1WtDIgPD4B+qWpL/wPsS6XYF4YysBVgXyoL+1IB9qWqVf/DYxfAvlSWnS8VIF8qya8wjjK7FSBfKsvOlwpwL5XiXjjehgD3Ull2vlSAeqkku8KG+76RABFQL5Vl50sFmJdKMS8cd56AeaksO18qQLxUTWtpFYB4qdTOF8LSgHiphM16gHip1NYXwiKAeKkU8UJoGRAvlTp3xHEfDpiXStC331eAeKnUuSNCc4B4qRTxQmkO3uAtbJoDBlTMC6U5YEDFvBCaA9RLpagX/FL4ClAvlaJeCG0A7qVS3AuhDcC9VIp7IbQByJdKkS+ENgD5UinyhdIGsKBiXzg+ogH2pRpPHuEjGqBfqtbWBQH9Ui8sXbAG9Eu9sHTBGtAv9cLSBWtAv9QLSxesAf1SL2juswb0S72wcJ81oF/qhYX7rAH9Uiv6BT+OXgP6pVb0C8fvfQf0S63oF45eulQD+qUu6AGwBuxLrdgX/Nx2DdiXWrEv+LntGrAvtWJf8HPbNWBfasW+EA8AAPallgQLo94AAAZU7AvxDABgX2rFvqBXdNeAfKkV+UK8GgDIl7qwxJ81IF9qC/lSA/KltpEvNSBfahv5UgPypVbkC/HWASBfanW5C1E/wL7Uin0hXjwA7Eut2JcSb/mAfqnHk0d4awb0Sz3SL3hrBvxLrfiXCm/NgH+px/td8NYM+Jd65F/w1gwImHrc/oK3ZkDA1IqAqYh3LYAFFQFT4eYGBEw9PuGDWxAQMLV6xQd/RaAGBEytCBj8IYEaEDC15exRDQiYWl2Xi787UAMCplZnj/BjgjUgYGpFwNToBQ41IGBqRcDgx/lqwMDUioHBT93VgIGpFQODH46rAQVTl7YxEFAwtaJg8MNxNeBgasXB4IfHasDB1IqDwa/QrwEJUysSBrc24GDqyuJCAQVTq90vhO8CFEytKBjC2ICDqRUHQxgbcDC14mAIYwMOplYcDGFswMHU4/Ej3NiAg6kVB0MYG3AwteJgCGMDDqZWO2AIY8P3gCw7YGr4IpCiYBrcZ8BHgdQOmAb3A/BdIEmzsAb3+vBpIEmzsAZvGvB1oNqyglTPHgiSHbDBhwj4RpAiYfCHE2r4TJAiYRp8iIAvBSkWBn/ioAYsTK1YmAYfIgANUysaBn+MoAY0TK1oGIGbG/AwteJhBG5uwMPUiocRuLkBEVMrIkbggzwgYmpFxOA30deAiakbyybeGjAxtWJi8Hvra0DF1I3FhQImplZMjMBfsAJMTC3JFvxSqRoQMbUiYgS6t6YGREytiBiBXk1UAyKmVkSMwB/IAkRMrYiYYVMnJgzsJ8kW/PWpGhAxtSJi2uIpr69ZAQYfQMTUiojBL5qvARFTKyIG3yldAyKmbi0HOGtAxNSKiGlLdGYAiJhaETH4xfQ1IGJqRcQQ2gBETK2ImBa9MrQGREytiJgWd0eAiKlbyy7CGhAxtSJi8KXyGhAxtdoGg6/Y14CIqRUR0+JeERAxjSJiWnTAbAAR0ywsm9AaQMQ0kmvB34xsAA/TjGeQcFnw8pqkWvgCdc0N4GEatQ0GdzAN4GGaBX1rXQNomEbRMLiDaQAN0ygaBncwDaBhGkXD4A6mATRMo2gY3ME0gIdp1KtE+PN2gIZpJNPC8ZcLGkDDNOoEEp4vsF5hmcQ3gIRpCpv1AAnTFBbrAQ6mKWzWAyRMU9isB0iYprBZD5AwDbNZD7AwDbNYD5AwjTqAhDvEBpAwjeRZ+AIdHhpAwjRM9T40ImkACdNInmV4071cXAvRAGFgP2bZQ9EAEqaRPAtfVHjOwICSZ+GLGhcGBpQ8C180uDAwoCJhCD0DEqaRPAtfoH65ASRMw5lFdYCEabjlCEsDSJiGlxbVARKm4ZVFdYCEaSTPQqkOkDANt0QwDSBhGq4siMbuDWBhGt7aVAcsWFoimAawMM34tDKuOsDCNOp1ZUJ1gIVp1APLhOoAC9MoFoZQHWBhGvXMMv56SANYmEbdtkuoDrAwjTqERKkOWLAUNtUBC6onlynVAQtKqoVSHeBhGrUVhlAd4GEa9fpygY+BgIdp1APMhOoAD9NUtlEQ8DCNuniXUB3gYZqqtqgO8DCNunqXUh2woOJhKNUBC0qqheOPujSAh2nqhUV1gIhpaguT1gAipqmZRXWAiGlqblEdIGKaurSoDhAxjdoMQ6gOEDGN5Fp4gY+wgIhp6samOmDB2rKc2wAipqlbm+qABZuFRXXw4eamsKgOvt3c2CIZ+Hyz5Fo4/oZPA19wbkqL6uAjzo2FSmvgO85NbVHd7C3nxqY6YMFG2FQHLKiIGEp1wILqXecCnW83gIlpRGFRHaBiGmG5ya4BVEwjuEV1gIppRGlRHaBiGlFZVAeomEZtiiFUB7iYRj33jL+Z1AAuphHCpjpgQWFZ0W0AF9O0C4vqABfTtIVFdYCLaVpmUR3gYhobF9MALqaRdAvHX5BqABfTtLbZBOBimtY2mwBcTNPaZhOAi2la22wCcDFNa5tNAC5GLCyzCQG4GCHpFo6/pyUAFyMWltmEAGSMWFhmEwKwMWJhmU0IwMaIhWU2IQAbIxaW2YQAdIxYWGYTAtAxQjIuHH9dTAA6RiwsswkB6BhRWGYTAtAxorDMJgTgY0RhmU0IwMeIwjKbEICREYVlNiEAIyMk6cLxt9YEYGREYZlNCEDJiMIymxCAkhGFZTYhACUjCstsQgBKRjDLbEIASkYwy2xCAE5GMMWHorMJATgZwSyzCQE4GWHbGCMAJyOYZTYhACcjmGU2IQAnI5hlNiEAJyOYZTYhACcjFCeDv8MnACcjuGU2IQAnI7hlNiEAJyO4ZTYhACcjuGU2IQAnI7hlNiEAJyO4ZTYhACcjFCfD0NmEAJyM4JbZhACcjOCW2YQAnIzgltmEAJyMKC2zCQE4GVFaZhMCcDKitMwmBOBkhOJk8PcJBeBkRGmZTQjAyYjSMpsQgJMRpWU2IQAnI0rLbEIATkaUltmEAJyMKC2zCQE4GaE4GYbOJgTgZERlmU0IwMmIyjKbEICTEZVlNiEAJyMqy2xCAE5GVJbZhACcjKgsswkBOBmhOBmGziYE4GREZZlNCMDJCNv5JAE4GVFbZhMCcDKitswmBOBkRG2ZTQjAyYjaMpsQgJMRipNh6GxCAE5G1JbZhACcjKgtswkBOBlRW2YTAnAyorbMJgTgZERtmU0IwMmIxjabAJyMUJwMw2cTgJMRjW02ATgZ0dhmE4CTEY1tNgE4GdHYZhOAkxGNbTYBOBnR2GYTgJMRipNh+GwCcDKisc0mACcjhG02ATgZIWyzCcDJCGGbTQBORgjbbAJwMkLYZhOAkxGKk8Hf9hSAkxHqhhj00VABKBmhKBn8cUgBKBmhKJlhp8J8FVYASkZI1oXjJ9gEoGSEbXuMAJSMUNtj8MVuASgZoSgZjp4iEICSEZJ14RwfjQElI9Qdveh2UgEYGaEYGUIZgJERknTh+LOPAjAyQjEy+CkXARgZ0drmEoCREYqRwV9oFICRaSXpwvEjMS1gZFrFyODHXFrAyLQLSxzTAkamVceU8A3BLWBkWsXIlOiVMi1gZFrFyOAHaFrAyLSKkcEP0LSAkWkl6cLxAzQtYGRaxcjgB2hawMi0ipHBD8W0gJFpFSODdqoWEDKtImRwr9ECQqZVhAx+dKUFhEyrNsigDym3gI9pJeVCdO0W8DGtuiQGdYotoGNaRcfgR2JaQMe0hTIfui+sBXRMq+gY/EhMC+iYVtEx+JGYFtAxLbMEMS2gY1rJuHD8/EwL6JhW0TEV6rtaQMe0io7Bz8+0gI5pLZfEtICNaRUbg5+1aQEb0yo2Bj9r0wI2plVsDH7WpgVsTKt2yOBnbVrAxrSKjcHP2rSAjWktz1C3gIxp1QYZ/FxOC8iYVpEx+FmbFpAxrSJjarxlADKmVWRMjbs5QMa0aoNMjbcMQMa0ioypK7RrAzKmVWRMjVsbkDGt2iBTN3jOwICKjKlxawMyplVkTI1bG5AxrSJj8FMSLSBj2tI2BAIyplVkDH6kogVkTKvIGPxIRQvImFZtkMFfEWoBGdMqMgZ/kqcFZEyryBj8LZwWkDGtImPwUxItIGNatUGmQQ/QtICMaRUZg1+W3wIyprUdVGoBGdOqDTINPkgAMqZVZAwFA1jQtkGmBWRMO75Mjd5O1AIyplUbZCgYwIKVZVGiBWRMq8gYgQdegIxp1QYZCgawoO2dpBaQMa0iYwR6rrAFZEyryBgCBiBj2toylW8BGdMqMkbgXhSQMa3kW0p002wLuJjWxsW0gItp1UEl/MxBC7iYVnExAo+8ABfTKi5G4L4ccDGtjYtpARfTKi5G4J4AcDGtpFsq9N6/FlAxrdoeI/CQAFAxrTqnRGgOUDHteE4J3SLdAiqmVVSMwIcfQMW0NiqmBVRMq6gYgY9VgIppJdsy3L6LtDnAxLQ2JqYFTEwrLOdcWsDEtGp3zAL3XYCJaW0HlVrAxLRqd0yLj8WAiWkVE9PiwytgYlrJtvAWfcmkBVRMq6gY/DxRC6iYVlEx+MsELaBi2pGKQXmbFlAxrdodgz8J0AIqplW7Y1q8BwIqplXPJQ0XZCIwABXTKiqmxQduQMW0rW0QBFxMO55Uwlsd4GLalubSWkDFtJJtqdFzPC1gYtrxsSR0nguImFa9lbTAgwdAxBQLxcTgh5rGr4a4ZWV+/GqIy2GwRR3H+NUQHwxVlZjTHT8a0hYzjl8NcYshx6+GuDJlgZ3JGr8a4oPFSvz01PjVELecfRm/GuItfa5m/KqLj6eX0KN441dDvJDYUSc1fjXEmRRHZwHjV0OcS3E0YBm/GuKlFEcnfuNXQ1xGOAt0oj9+NcRrKY6evR+/GuLKqujIPn41xAXtwMevhnhLe+Xxqy4uaZlygZ7mG78a4tauyqBVmbIq0VUZtKp6XonqHgxa1baVZvxqiFv7KoNWlRxNiZ/FGL8a4nL2gd+hOH41xIXMHZ1/jF8N8VaKo/OE8asurrbV4MHx+NUQL2xNjEOrSsKmxDe9j18NcU4HFeNXQ7ykY/XxqyEu+yq+jXz8aojXdGgxfjXEZV/Fd1qPXw1xy+LG+NUQV1ZFQ5fxqy4uCZyKY4eQx4+GtIUgH78a4szWO0po1NLaVUtoVHUKihqaSmhUdSEwNTSV0KjqPhpqaCqhUUtlVMIBl9CopeqqRDRTQqOWljWr8asuLjmdEt/fOn41xAub36igVStm8xsVtKqifSi/UUGrVqVt4KugVSW7U+L7Ucevhrhl5jJ+NcQbm9+ooFUlx0MOfBW0amXZUTV+1cUlz1Pi+0fHr4a4tCojzFRDq1oebRo/GtLq3mCOd6YaGlXSPSV+Z/b41RCnry8dPxrSNf2MzvjVEG/oOwzGr4a4oJ/SGb8a4pYXuMavunijbEpEVg20aUNfoz9+NKQtd5mOXw1xbsscmlTRQ/gFnuNXQ9xm0gaaVN1kg9/hOX41xNWVmOj9oONXQ1xdiole+jl+NcTliIpfRT5+1cUtz2qPHw1pRbcTHUlAkyq2qCS0LqBJ1evaFSPEoU3Hx50IPQpoU/W+U0VYSUCjqv07JdEcBTSqpIZK/Or18ashTl/TN340pCX30FA1hTZV+3hqwgm00Kjja9uEYlpoVMkRlVSY30KjtrZ+2kKbtpY3L8avhrgaT4lIo4U2tbz7NH40pC13To1fDXFBv4g5fjXEW/pNzPGrJl6o17fxxznHr4a4Gk5Rtmr8aohbhtMC8kmF2t+D3+8/fjXEle/Fa1pAQqmQlFHJUYp5/GqIW2xaQD6pGF+DQhcgxq+GuOUio/GrIa6GU/RSl/GrLj6+CYW7xwLySYXikzge+BaQTyoKm00hnVSoLT/4Q+LjV0O8pLcGjF8Ncct4WkA2qZB8UcE5GvYWkE0q1N4fQumQTCokXYRe/jN+M4Rber5ZQCapkFwRwbMWkEgq1AU5REuEPFKheCSOs4MF5JEKxSPxCmP5x6+GeEkS7ONHQ7qib3UcvxrikkbCt12OXw1x6XYXJa50SCMV6sVuhq5njF8NcUXjo/cSjV91cfVq9wLdkDd+NcRVF8UD5ALSSAVntqpCGqlQ9+ZQVYU0UqGe76aqCmmkQj3gTVYVWpUrq+JxZgFppELdn0N4AMgiFZInKvHNt+NXQ1zGvBzdTjR+1cUlUVQS/EQBaaSitExjCsgiFSWzYYEsUiF5ohLfsjt+NcTl1BTftDt+NcTlWIrfTj9+NcRrcj1s/GhIqx1feHuBHFKhOKQSn+AXkEMq1MveVNeAHFKhOCR8r+/41RCX/bQk+inkkArLI1PjR0Oa0zvjx6+GuDIp0ZEghVQoCqnEJxoFpJAKSRKVJR6tF5BCKipbN4UMUqEYJHyL7vjVEG/prd7jV11cnenCNwmOXw1xZVMi5IUMUqHencJvgB6/GuKyn1ZEVAoppKKmN9WOHw1paVN8j/H41RCvrYqBNpUkEa0YaFRFIZGKgUaVJFFZEf0aUkiFopDwdwDGr4a4NCq+k3n8aohLoxZEX4IcUtEoo1Li0KiWN6nGj4Z0ZXGmkEMq1C4jfBv9+NUQt/leSCEVjbC5GEghFYpColwMpJAKoUxKDNaQQyoUh0RF95BDKmz38YxfDXFuWcQpIIdUqPNfBOlYQA6pEJaNY+NXQ9zy1NH41RC3PFc1fjXEpVXxLfPjV0Pcxt8XkEQqWmVVwrdDEqloVUcl4hhIIhWKRML3zo9fDXHZUfHd8+NXQ1wOqfj++fGrIS7dL76DfvxqiMshFd9DP341xBvbVAzSSIW6rwffcjV+NcQtu8rGr5o4W1h2Bo5fDXHL3sDxqyGurIqvFTPII7EFtyxvMcgjsYXlrOb41RBXVsXdEoM8ElOnxXAWgUEeial9STXe9xjkkdjCxuEzyCOxhc2oDPJITDJFJX5AYvxqiMuuih+RGL8a4tKo+CGJ8ashbnPADBJJTO1Lwg9KjF8N8coyu2KQSWJqXxJ+smL8aohLqza4I2CQSmKSLirxNyjGr4Z4a1lRYJBNYmpfEv5oxfjVEC8say0M8klMvXtFrLUwyCcxxScRy5AM8kmMWV4dGL8a4pZ3B8avhnht2RvBIKHEmLIq4QggocSYbQ8hg4QSU/uS8BdAxq+6OFdWJfoqJJSYIpTwV0DGr4Y4o6/HH78a4py8o3v8aEiXFjKcQT6J2e79Gb8a4rKr4k+YjF8NcWlU/BGT8ashLrsq/ozJ+NUQl0YVhCOAhBJThBL+lMn41RCXRsXfJxm/GuLSAeMHLMavhriMlfBjE+NXQ7y07AJhkFFiilHCZ3sMEkpMEUp4+4J8EpOUET7pYJBOYpIwIjYBMcgmMcUm4fw2g2QSq+hD2ONHQ7ogH4MYPxrSsocSuCGVxMYXywlpaMrxuSxCGlpSvZeFk6AM8khMbUVCt9WPHw1pdZqXyBvaUp1EwyNeBlkkplgkwsVBEompbUiEviGHxBSHRAxbkEJikiQimA8GGSQmOaKKqCUkkJjkiCrCOpBAYpIiqvEVFgb5IyYZIvwJtvGjIS27JYUb2lLyQw2lb2hLSQ81lAahLSU7hB9mHT8a0pb1NQaZIya5oYbQNySOmKSG8BOc40dDejAXftBy/GhID+bCz0OOHw3pwVyCsDykjZhkhgRVS2hLSQy1VC2hLdUBNco60JaSFmoJXwU5I6be0kIPv40fDWm1rEY4K0gZMbXtaEG0cEgZMbXtCD9ANX41xCUNWOCbkBmkjJjadlQQBoWUEZOkELHkzCBjxIRaK6UyhxZV246IHc4MMkZMbTti+B5kBhkjprYdEVtUGGSMmOSEiKV4Bgkj1qr1b0LrkDBi6ugaJzodJIyYpIQoCpNBwoip42sEA8QgYcRGwojopZAwYmrfETUgQsKIKcKI4DkgX8QVX1TiS/0c8kVcvbhFMMcc8kVc3SpELE5xyBfx8aZn3MVwyBfx8SAbHoVwyBdx9QZ6RWGvoLg6101hr6G4NCr+fO741RBXizBUVQUUlz0Vfyh1/KqLj7cMEVWFhBGXlFBBhAAcEka8UCtrePvlkDDi42VDhGYgYcTVi1z4/RfjV0NcrcIQioSEEVdbj/A7MMavhri0akMpElpV7T0iRmsOCSOuCCNBYYdWVW+kCwI7JIy4IowEgR0SRlwRRoJoBJAw4iNhRFgVEkZcbUAiTkhxSBhxSQkVRLDBIWHE1VtdxJEnDgkjrnYgEcEJh4QRV4TRAo/vOCSMuHo2fUFpBlpV3Ui0IDQDCSOunk5fEJqBhBFXhNGC0AwkjLh6Pr3AQ0IOGSOuGCNils4hY8QVY0Qc1eGQMeLqEXUiVOKQMeJqBxJ+VeD41RCXVi2IRgAZI67eUi+I7gEZI65eUy8IHwkZI662IBX4GM8hY8TVSTZGmAkyRly9qU6EhRwyRlydZCNOgXDIGHF1ko04kMAhZcTVSTaCxeCQNOLqbXViNzqHtBFXr6sTexE55I24ukWa2M/HIXHEJTfECN6DQ+aIq9e9OFFVSB3x8Z11ontA7ohXKlrC3nsfPxrSJX2/3PjVEK/oKJJD8ohXNA3IIXfE1SVGOFfHIXfEK0FzdRxyR3zcgUT0I0gecbUDiYo1IHvE1VVGVKwB6SM+XmZEtBbIH3H13hd+idb41RAv6cuuxq+GuOVSqvGrIV7Tl0eNXw3xhr7kafxqiAuahuOQROKSJyKIHg5JJN5YNmlzSCLxprBMgTlkkXhjmaRyyCJxtf2IoHc5pJF4YzuWyCGPxJvKcliPQyKJS66IOjfGIZPEG9t5Jw6pJK52IFFuGnJJfDzERgyPkEziagcSQSVwyCZxUVhOmHBIJ3HBLOcuOKSTuLp/mjgawSGdxCVhRO2O55BO4qKy7DDnkE7iwrZLm0M6iatTbAT1wCGfxAV9f8740ZBu6T1rHLJJXO0/IlaaOGSTeGvb0cshm8TV/iOKeYB0Em9tuz85pJO42n9ErAxwSCdxtf+IIiogncRb2/EYDukkrl5uJ05rcEgn8fF2aqI9QjqJt/S1ZONHTbpUdBLBnZYjnfQfT5+sNl/63aFfvt4s+29Pfvj11yc3N4fv9/2Tp/98crNSf2TVU5ntkx/++YRXT3745/88fdIW6t9hd7D60ZTqx7CFR/3g46dhhUb9aI4/JuFmEm7E+ENMqcQkLCZhMQm341+Gufb4g00/jp+a8Qcfcx6C/fHHJFxOwuWY8xALqh/1lKqZUk3g+QSeT+D5BJ5P4PkEfug/8kdZ1NOPUbicwJcT+HICX7JJmE+fquOPSaaaZKopw8kW5aTwcqpFKaYfRzztJDMps2ynDNtRuFqMnyp2/FFPPyYZPmqsmrRaTVqtJq1W5SQ81aKqp08TwmrSczXpuZr0XE16riY9V2JshnUxpqonK9dlO/6YtFE341/aqRbt1DLlDQbTr2r61RTHX/z46/hVHNNOOpWna6dfI1R5mHP6dfxbcfxbMeU3HMkZf5VTuUV1lKuOX+ty+qX08j9Ppw4t/zd08O72tt/vD9vf+43Rf+v61IHryTp1VZHZHFZbMweueQBuSfalG5L299vbz3r6UvMgSuNUesPxDMdMjunk4RJbyn3fL/XUhV4qq0mlLY1UwwXkx1TDteNkql2/3xvlaViVipuCH+09tRU2dQo5IbNmfrMykGm1qSYfp/4V7ZTlVN6xKVVTO5v6WXH0pgqStXijflV7AiBII05pZRottSg19XCLMYbk3f3qdr0aPuitQR+H5AULY6Ubhx5/69bd5rZfr/ZGfnqnOBqnsWfVGxoZ9jueELHCgaMf6mW0mKrR+tVishBf+GTUfVtt9/fdrru73fXdYbsz276WMzs6NL5w2E3m/LG7PWx3302kel86uju+cBhS5XdvZqW1BDY5crmq5M5qtTn0u4/dbW/mWOtqPFWWdHAqR7N7DXdIas1rQToblRi2pkLv/sWxPTn62H13+Hy/6z+uvpntihvtimyU613fLb/331b7w77f7cw2MDxkeuqwCxLJ3fbB7GiF3namKGEKEqZGOg3XbIpi2snZtVP4IE8yTmPW0c6CBDJ1eqOPDfO7kz/mp6G0PGZINpz71e12aTSV4WmjY27NFMM0U1TbTDFMM0URzRRlDQ+9qx9TzYdHuNWPyaU2U1TcTCoQizFnMQ39ohhzFlMoJSavLaYAVZRjzmIK9obH0sYfU86TRgXti+9X80ax4LoCyO57v/q9/24GEVwPIoopiBir1dLdV2YlUxpDuzCGdkuj+L3/fr8bIoseQOJ6XNNyspfcr+6GMeUTaAmNrojJ3FMDa8rJ3NVk7ikUa6ZIrJn8ajPFpc3kzpopuh7ech5bwmTuqZ+IqeeIaaoi+GTuSb9i6m9iGsjFFLEO77qNLWHK2dIT7nfbL/3NYddt9vPwrmD6OKYasV8uN/vVp02/vLnvvq+3neFP2UKPvuxZEriG62h1l0xaePfpYfjDvLU3mgtsj1E1p4PB/b7fHeSoqryqOQ9mehhLhob7fW/6U127x8nx5D4nc06T23aaGrSnucQ0cZFbaKfokdTGUD6IHQt9QJkmq9PEbWqGU5ubZuJs/IMlKhqKIoI1vdKL+jgoN2QbHfICQzLXQgUxdam2OM2EyHY1ZGaOI3r42tqNN4vTaj1O48e6FGRPmXKxB2m1piNeHC1Lt/MpWyxC08dJzo6TjIWzpiA8q0s9n1OkR3roKR88NtN9NGfHOhZkeHXY3q1ubx42q8P+5r7f3Tzsl7dmn9YDgmmklMs4VI6Hfn/oZnNa3aZk5R4On/vNYXXbHfpd/18PvRn0DQ+knbDQ8ebD4fOh+2SOf7prK0rSIQ0NyFRooTeaqS9P4xavjzTTkSeaGB9x5G6OTM3EuUxDWj2NUjWj1DnOpkxMmqs/RgZTb534EjYBkcuF1szvuntTzXrfLY4mr6i2/Vu372+G2NokMbSQoybb85AW9H9W6nNFct48pLzrVpuN6f65Pj1pyaFwSL29H1qpOejUOuqpudcWDe57WPPhjgGtzRyJ0YlGmGxVTqFJOQ0z5RTQVJNdK95ObYZPbWYi4462L6e/VMch7Ei0jUwEAX3f32/Xq87Un97hGdXJftttu+VtB2ZlTNMeW7TT4HsEw45zFZLXOmZ82HXmbGK4XPSYe1lNyquPPyYtNsfZ04l4JNuBURzidAq9SlMoupgcNauoQUnPeLP/2O/MaE1rpOVEKJVT9FpNNq6m7lwVJ6aTGq9mJSK1YZo7m+JgeT6HyPJhtV7errvV3f7Q/d5v7/sd4tn17ko3tyGr//wKHDrXHTppoyGpDUCpA3Dmstp8QvMZrkQ8GWXqt+WkpnKaOJYT+V0eyd1pbiqvTwwoHrOQNsYdB3BWkd1lyPZhY9OOzgbXVnhfu/W6PyBk63BkUKNIODUS3HabYYpilN9qo0mzOA5PnGpzsrl1v637G2TsazTXeiQ+SJrtmBWSE9MnK3VDdeN5rM2aQlcoXfaQ8M9gbNPgUyHZmHBwz+Z42ujjKWXHMfXwZ9AOKq3smjnTbz6uPj0gzUkPiGq6IQAmyKSVyESrDaz2sHVLG46Oc8qKCuGmTP6MNGO+0MA3BWk6kMWf+2+Hfrfp1jdInkxnpevaVbdjnqqvoTm2eo4kgXfK8X51gzBPWiYNc8OC0+jhPfDTbFBQccApg1PsDpBwPZwkid5jRkhf5XpE2JJzLJjFzSyw1Rx8S64fHLPB26M+B2Gk2zjlMfhmyLLqbaYlZyPHTKR1QQ66Rkje+5jDx+7htj9QjBTX3XtL0jXH3Pb97ku/U2yUaWuhw6Kd6jEjNR7eoCPX8IKclpmzjlNmu/5rtwOLDTosknE75jQLPbk+iMmXqNw54BSbkQ856zPzAcFjqU8A5WMirky+34OVND0MlI8WOHJ42AMI+iRL3oXlyuCwWpsQKoORbp05fOnWqyX0LaVOn8g7ihy5KK9rZqFXhZGswpQF7ed0jqFduBrZNML2H3fbu//cbzfIbLSsDNqiPtJDziEUy0xfpJRXJE6Z0a1wve4V8fxxu7vrAD+r+/Xa4pTv7tf9wZzJLfS15alabJrssOPCenGMgOlFbDJUKXQOkk8TKD6x/nxiYcriuOp23L9z3IAzzb+mmL+aZtb1tFunnmRqjXGh7aOBVcT3od8BCkIf/stTnrSZQEsyV230Mc/iKzb7w+7hFnKmei/l04SeTxN6ftwCNU1Yy2khp5w2DFQTwV5NpFlVTZ+mCL6e2NiaHbfLTOTGxJbU01aqZqLamol2bab20kzaaibmppmW9JqJE2+mJb1mWtJrpt1jzTQRb6a1ADFN9EVxpO2n1aMJqpgYajG1ETERMmJaAxFTlcVEGIpps5OYSAoxVbCd9jK10/poO2mjnarTTstj7WSCdupG7VREO+XcTnvO5DOH05zpSOtP1Zf3pJHN49B/M/xmq3dhcq/QkHDX3aJxbqFvcnBlgEXzXMtAWFyi3HS5P+xWm0+H7Wdzo0xZG5ueWtr933/H+ML/v7Er25Fc15H/cp/nwZbkbX5lcFFwV7qqPCc3ZDp7GeD++8BLUKSscPXTKTSOKacsUWREkGp1ds1jlJmOsIxsrSMBR7mN9cnc7Olg1mE1zbXx6x8d4EasJi/QcAFoeunO9Rfj5mAKTTSIOZ6Vreby3MDc1EfNRaBfcjGyvczH67oXzmnktaYU9WpnDWL3MWzZaKoCoOKme5glptCswnsFClztB8rNpHaxEfChC3GxmQFHNXgF+jrIGQcZRYDXCyAgG5HwFLUggjxhjMPnGBp1dAmlL9JMRyV4YjWDlGrQtxMSFecyGJQKKqAKDrqOwhjRejkeRZg3yMZi2uGVTYzFvv1SDIzV/itEMPZ42e4jWKdXUIVvWMkBLEQUKN0KOPNy/RROgeOZWYfN/Qj1far4pY89obG2/0U6sqyEjKf80/vzp+WPtBegnvXUT4b40AIVDImQQQ5IeZftD2jzHHTFDnPgKNR66tNoWB8FcDhdx37uafjx+vwcrwnD2ZlUQcTN/DWG9/HSn5NDRStTEJewlXEaPvrX2WZTlTlOG3asb49mwwL9+fhCgoWc2KjRMS+i8g6MUYfUp0NU1lEU9zSc+z/2B5p5pljCaXiMP1MJVWhNrhn4qM9pvO4BEfU0IkInQoZSXEgpdIRv+SKa+iQlL/VW3qQvuSfH5/3c/3lLNWallo/wQ/w0zpHYj9eUyMeNbIcqTU6vy+XP20I4vx5ni29rYNqxZTN8fAyLfj3HLuiQivJIw3VmFE5vH0M/vR5DsnY1v0Yd1nB9f/y5JzMQvFlZdAKH6+ltGu3ca1CeOvLh+ridz/M/vaW+T2O9gS3pwdLcXgdbnT94angMr8vX7Tw8/7GKQp1ddvyTbRayZH+jLTBXBwuCIV1mliuZA/3ppA7EUWxs+JnwQo35fPRVfo/TvmBDM6j0u/++3x7W2Wris+QVBjN9cT3NusHXj/P4/pZ4pcYI/ema3TiQLAWixaqxckZOSU9Z0cQqEbcZvLMV59b8pdV9JUBjauyiTIru+YzBb8RmOqqXoiNPOafcCDndmZ5qHwGnkm76nF0rQdNkhA/yzUq+EPcm82o0vT59FS2ziHn4veT69+GSao+DstRR8vOjH8/JsaKFFlLU5ZAsOC+LVYrUSs9ebyVRtHmdEyAjqBFvNxilgVKndFT2sto+j5dxegz9+9dw2lN6eh+0NE1YLTECwpDeiH7wZVwUjlIdx3bsmVnQVKOEyDSm+hgm6/68ThtbCGI7qbMqJV9x1D0tRjcGaCWA7MGsuaSAmClAjxSwDgIy8CAboaSoWGZMVxSP4Xm/XS1rqI+pJs42XQx7w5nMS5+eUp7FK+8+xuFsJeMm3KFKr4/xvJO4hcrU39T02dvjHwMa6iCP6pxXssHEN3qBYP6Qu3b0dJkNzcd8Cms7Db7VQP1rGq/NwPpbvkywdCZlOrawr/3RxT9ly46f9emd0F1L08qWToI8/JbqvTVidPB0toArGJF7QeU8i4FFZbz/+V5nHC3/jI/bZYvWE5G5jkBp+DM/ntFHqO/WIFJpwGw08AMNiqoapI8NEPcGDrSB4LARTA1OrAEM2wIFa8GitGCkWsi+W5xBLQKGFgqzFvlei/LzFl67xT5om6PVd7mdhrOdfJ00IKrqpJquoImAmOuvp1wdgSYaOxrxfGaVZqU+oRx8pZMqCTAzHsyMjy8ciQyqy4iD5oTVej05JNEO55DrIOUFi+KlwrygWVccMdk/heHgKUw1P7/bOKE0OgJKv8wPf1Pz05i3YFtwNrTzP5o68YhxPPaSx+Hqsay98LoFPfowUOqqWu0oBL6kIMXnMOU0f51GBqV6DMRIE/E9ehp+DtP76/EYrlOqiXCaz6owCxUY7AqupUKsUUlaUFCI7XOYMiib14RJR2t84sM5SafJVx3N36OR9Ad7LYTsKF6xGBA8C4ne9XQdpl9JeOA0iVHTwzRrMT2dTHkxFUh9DtMGxoy36w6tM/XmtGpltjFXr43Xz7kpQiKcLY2Ng/2VpFXZwg8taMAJ5YH7eUDPHgCnl3i+oAIbNfKhOFpvnYDNHrC6gxcBAIgmqUYuuoOZO4gvjGeiwSJs7H1kYQIUms7CwN7rhMJU1R2dZPZBp5XkdStEGIIC1BF1ON+6VjyjcFVFiAy9pAwUJPscpm1Dpa+iZcOidCgQukh5T1FErxqHYxHp5zBx/lRDHyja9ZDUeLBQHm480Hw+GWWmjl+JEzOAOgUAZ0NL6WymcjYY5LkQxVFBBTdi7eft/LpO/WPuCTBtRISNUDvtIqmIdja47r1cmOt0M4+aQuPRSEatUeoXCQg4A07mAAo/oBQ6hHg4HfhhO2ImSdUxQpQd0IRxNZl8Za/Txk6sFNLlpZAi0aKKXN3Bhp9uOX9hcFAKUq2P57xFMM8fHOkZ9l7DE0Cfg1SKYRcFUJFBYt2CIjWfHAUyqFghtUUF1W9YW1/90wI4eoV2dfwsojihgjhr+Dxe/7GGdd1ALVtTYLuCwmDWcLKeTBXJd795p0jQSgsQwFUh0gQQ8EgOqjIKEQ620ut64KJMriBVdAWtPvscpqxg1mnlbwWJRoUCxApJboV9VEnHuZJ2n9GDJXtC130sN2VSCzldg5YB4ONXULVVSFkrfINaqouKJp6dBwtkHTOXKGhCrMLuq1r5A2pQKOvqKKKhrIQMmJzQWpxeR6lelGuFA5e/WrTLW0cfHT8vfg2GFPEaZOsoUD0/9pbTDnhNTXSRR6AM2lf/fLvcLJSs0zwY2CIVoeQETIfbwpw5CDAdlrGjzvFrmu77djUazkfdXwNn0+BsbIAYNuA0mlqkIsCN4KkbCf9EwAocoQWO0ALDaOEqWuSPrXQdQ7zfIrBu8Stb7NEWiFSL9d+2zEPYRWi6McnsQX/q4A3qKBoTkoOtr/Gy4ys1KVY62pRgfTIj1a+Mgp1WRq3/u2EQ1W6OreHYCT9ex4RnLcx7My82Pzf25/H/Ug5KJyI1/SDXNQvbQ5WtPq4ijUaDqMXSz/68FBkk+WgwhRtirKTY4XhdfftG9u3bXmkclUIR1sqYIbd0FN5QJB52lugtY0RvYFqVAiNLs6M92eC1ALSLLWAoZgV7a0yY4e00e0F7oWxWaDmD11BCJ8vYU6HKZlBBJZlX0+G5/8bSwk5mJl07bVr3stmQJDXzLrr9DIWTNjv3/nPIvIrm2Siotpkw4VbmdTQ3QVm1zRYCxezK1k3QaDiSGFqzoMxb6cmmBXabsYOQ0mtwq1O87zfvt3rlzI/Ujc6+W5IIgzJmdIEuTcDH59vlbtvUmPQWTo1+tOdcJnNJRFROu/ma++nnOqk2QDe5I4X5xuc0PC7jirVNSYmhDp9E5FLQQGz8aR27YWTp2Zb2mdNlHDWtBEvbL3rdiqOTBpUlRfpmAxbYTEpBTF8KIVxQEAYpt0edkZderwVFVdSY6Wi6xwJCGtfJH0BWEeR46YFVCFDnaPHmPG4ex9Gss3QxBO7WiJLT0UaBs+k8Tmx/oF7JHmGrR9jqEeB5IA0+NmamitHz2vZS0LhFAJcMq/Fp6GE80EuPdRKQpwXaFigdLBFz6J8HDNUDGPLSYhtJWRBss6Qw8DzigsvYb6Z74gUoxYK0fQL3GpCeBCyQWvrJFfXRlIrDt8NqPAgccgUOuQJIXGEbVFJBh+SiLGl8PQ8rCbsdV4cqFXK4CjqzCmL8CgunikJzirfNw5lMOykjNbpL/B7gWxXY1wqzUEs9SUFz2zhkMpb+eVg4FT5ZBX9T4dvV0uinaATEiTAmX763/pQ2yA6NyX48/Tq3z/4+5lREoTY+nla8XfrzHNUOpw2PzUQRurcDRTov/fys/Q2GzqIH7KX//ZZ1vaE2pV4U+c+o+k37UTpwRthbGqadFhTsBBKu07g7TodOZHPIsTucIB2WaFkU8peIYIsYl8RDRGAjRx3T8l67T6gL3zvRPdDAa47/bbf30oQs0ilrU1VRE8P0xVkG/XFlLnghzJYLpLIk5ds3E6K72HysoJX/2nCU7b9wfVIzJCg5AggnHUGBovB6q+31NsHj6/p83WdcIqvM1L2faRUoIeg0/Ief0mABNSifbuUOkJKC6dsAiUjKrBT+6O/p7Z5sOd1/YxtclE4Sq+APTD4+vANg5fA5HD0Ir7ddxxcN/FM/e52T9xlwyYgJvGbLu8Dc7fU2fdxe11wuopxkQwNqYcvXcCVpOeOM4JbSqbnKYq2dhqdBpwGq07n3j+dwxCTUpqMEDfjv/WOGsiz6Znpt0Nxze/TQURjlSJSuss9875/PXzfb08VpaqEGk1FTBus+XE9JzVxpGDsJgUV0BibHCb0YV3kZmxpSEdI25BwILCUCqaRCi9q5GPg+Jt1bnO6aV9Mz+P4YL/3jz2m43i65YjIt/2wRZbW0mpU0BddpZyfdBUoK4OVLUNREyG0/CMWIoUf/y2bgpnk13WmP/hcjRU3xY0GrAB7D55LGL/UfC9T6PtzTQDpoMqUsabzyGHY7tDDKJRcp1Ahcc2tLvNc/PpMFowMZGu4hWtzyy7WO4OOVIMil3rse+87jTPZw9h7v66VtTUGrJVHTT4bURaUOwZMTIQnSSY8N6+W+n4LyH/OQ4yNzmDstX63pgfkYnrfX430Yfn/1r2c+KtD9KahG89nvL9MJjQmTKWa8e84bhkTaCZQSezr6+WdbSShm1DXCR9LMRTu6fXmcUdlIAExDgp2xx/BMZJCm/E2ufXK06Hg2uav686YPVWy3Q4Ha5/DYSJ5+6seP6zCc7EdwujCjpn7ENFF7Szlh5RAlNI89ff/K5F5IU2oijJc2rmZ2LJrT4X2N+Lmm8TMTiOneYZGnRw4VOxJEojfeqHOwXOJg+SpCb5JnUY17eqHHDuwya89eqCFv+tfGdhZbE5mJs6eU2s5iCtK2Fi0Qg+z00AZ3towUVloyNMeLe8Pu0upLnfEEiRk8Fe2nxo4rLxvTmSZWXv7NMmVVl1rf5OP9X7R7zs6mrbjU7RZ9KyuRVrCk5vLVllor5QUG9LS10jfSymAiGLmJyFMl8Xo5xT/Dn+l2+/G/w7sV8+gzvD44QqYf/XN8X3r4Z83oUIaK1mczQ/8YHtyOzh5o8dJzmHaEiXaCNFp+DtOKnl0TjUlojSKK1tg8h+nGX97Ui3MHMT2H/vH+tWyV5G4V/StoU5zFQhqZmPc/WFybRpZF287E67TdUdpO2mvCquskOqbc9WxgV7GqmRh+G4Q8SoMa2xY7uthvX+abyEYruEofzwLqw3aMZKnpaxdF5VQiza8W0rVGQDMhQRQAk0vFN8OilX6bxdIGZdKTSCs1uOI6h/lqhWcZ9ewUmputz71jMz/fbFgezZ3751eyVUzWxZ5LexfpLiZUabS0e7fRjfHWlJtcHmTN1U2rSGGv6A6HqWxzde1feNC2mEiiA73Bg+Qtnq+vzchxVKDLIILEa/6bicq3ozAJuuDcnkqoYCsXWejFH+JdR5QBFls2otAK+RD7btDsFWbykYQmPkJsXkGL4rbbBxYM85IeeJVZmaLh9hQT4bChfq8yRHd7NPHRUs6gTnAryTeocuyoQkoHBnKlcBcL82OcRwsqUvN5NkuPU0vWS2+jS41uyqLr62LN6s8kLVFiawieJuk+Bdak3ihCm0W2ChKIMhw6GTG+l+qVpgg9khK0kp53iHA6/6p5HmcMzCKe3Uwasb70CYz6ZSpYmZG7ad/bSXO1Bx85aSpn8FAK1u/jftPpHLpfhyzNycHPD+rXj8toxRszRJIPdEqdpHrMkQeT5+FdA0j/QFUNmXERbdHBdecb7FQPcb+XG9oBVwVapT1/tNtryipuTd9IoSZLGotMt2ynCP1dqPR5fnZ/IaJeClTfg0dTOlafBWxbZQuivLmshWY60423h9ANb2hz9+k2tydZ+/vaJEdzbzRBmG6ZR3W5XI3VWEPA1ID1bEBJNzglG1RtNjhOGgDhDZxpA4yrwZprpGcQhmgBarcAtVtwry2AsRabsUX1bYt4qcXp2GILt4Dh20bocliGI25Bk3dyzXAjf8RCUSl1EYSukBylkKOjFJxEvEfpaPw83ab+/Pa+W/YmS9ysyJkkKDJG74Tdh3KQgsG7GrzKNATZDMqhXQhkrbqAqlZkh8OkPWPMBQ70OFgezV/THJypbZaWa56Ce4ux3S3axow6mKl7WQRy6X19mkYNcgh7is6IleOQXQdnoYqhMctgxWwmznY6vAkRFaTMSjRm+XytJQpRNk3rssVONtJ2ujQkxJ7CFB+jVwrrmENQEYCAThDbQmiSQnZPEeI+kuicRgz6OuK0DtRcMSUIAYqIjj6cmLQ7xTQGl0SE1gZoQ2kpqWkPCmUK1SxqS/P1Keal9O6V3ue0mSurQi3NdcvSz5/G2drOHq31RpwRE8kj72LN7eJY3W7OQY/khIVyFAhWptO5KzWz5UTE7SgznKvA1VAyqCGH09FF7jcyZ5H9ECfnaYiPIXeXOuvuQDSzxtOEhDIkj6gEPaWpYW7nujXg42IHfppVi8449d46hapE6O55vKQMHTpwp8spQzwrKdquLed8uE6sqiI6y7/5yYkb13FFiFwJxdK1qbwn1/VrlejNPQ94TKGPXSSmh3a8XJpWqidFQ+lG1synA0rtvIRRVEg8peCkvpmGClZf15m4uD1mijzTd01fB0l76ryu43xt0PxvWSO69SGNM6CDy4Laztw+gnCRQlzbFZsUOjVXlcEBHbzYIXiq9QM0slSC1CX5yuhPdIM3inSmfbR1vlpTqcHrmYS0+vyhgNzudnHdHqSjG/n1HN7onXO6XTy9YCLtXVXqPeZQIVOW8ZpdifxdRHhpCjqbJ2Cx6WKkTh+68p+z+iqpTNNq7xo5Xk11wLONvZ/X3RRk83ual8PIsY/X372K99fTCjhYzfp3fZWE9A7x9NIqsZX4dt0m30XffjTjB35dX64hDew81RO/nvRmGW/08ZIyl7HFBtXvb+U6w3t/jdcxW/hS8+tUl6HsZEzoEJnqTpSJ/T2JOqZtaMMQZeKVew99zNCMFkZ2DLUR0jgax2T7o5T6ThYXO3DJypacqnTUG4jlXQSpI2qqKI+P318/UqWsBqZKiseJCeKUTKv6IiYLbFGLvey1EfoiKmlJ7mg7VzG2j2kN0xwdMNu5sYgtdXY6d6lirfz3E/a9x9NoaiUnh6f5nzGdc3ta6V9FnIPKEqxB6/s0oFNJCy9PM2ZjK+8AdaBUxe4TdPn+6i297zVr17UCFFLx1Gzg45bxn0HLsEpHXXDmQiHjxLdYLza/kCZ4LqpIpSzBU23KdoVzIt1USxg/VdCXqEaTkGL7Q1TNVKe2jTafVqlM14CBUfqMMfAe30xY9ipqfapEdIjuyM1S3usYua40ivf0sFqNrTdGZS80NZhH3DkUTFgN7iXAhqHxMd9i3iLXxil4I5am0cb67M716b4sTlhdT1OITHVrY7Xfxw+mDtPcLRQTYtpgLJr5xlvqmK6O3uN4lTNXqVGuSuhjTytwlDXrJ3X4X8XrkiipGQ3lnaReQpVU6nkq+t/s7RSYu9xd1/rI9QwuTiRlznfdvXShDoVg5uZe9+HxttyYY8k87cWlt6unwqZfu+uCtAEKi/wap6/To/8158b7e3KMAP0bC+fc5WKmdCo7df/+r6Xi6jxeh3/99//8+z//+X/TXucE5gQFAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE+y9a5PbOJIu/FdOuL56akSAF3C+eWz3jHf7Fm33zHtiYqNCXUXb2q6SaiWV296J899fEiApIJmJu+SN6f3SLRdxeZAJJBIPEsA/n+13vx2e/ekf/3z262Z79+xP7Pmz7fqhe/anZ7f3m257/OP6cfPs+bOn/X3/p4fd3dN9d/ij+nTTf7r+eHy477/f3q8Ph64v6Nmz//d8Lquq59Je3N3tu8NhLmqzPXb79+tbs7QxFVLq82eP632fzAR2qqtYsXKu7Lf1/X13vNncBVR3pWdyVTzlpABsu+Nvu/2vgQiMXKkQHp9+ud/c3vzafQmBYORKhbBWnwOlYOSKgID0uj+v79fb2+7bzeHoh0TLkNoX79bHdVylV2NWXxnorSTAfFwfbh52+y4SkJY9I6ht9/l487j+EItKz58R1nF3XN/f3O6etpGd5sosIQ0a0qv9u/Nl+3F0B87Xc5O6bMa+mtZJs/bO1G5p6499AU4UQ5rUPug/rc61hU6qsinUfDZ8DKpcy5FW9V13u3lY3zv9p1PVWo60qm932+N+fdtX4OfCnSAgOYOh6P1stIwOAGOq1L62fvAYW3pdV3MOZyOnhtj6WVDNY4aIig357nfru9v14fhuv77rfur+66lzzjBonlTZHzYftt1dby6/3PelRyO4WpTjFhAqAkpPj4/73afupu/k20Pfzze77U0u6F5lJzeH0v728L7bh3cAPdtX6wMLEIndwJAFIbqnzf3d2+O6//Lhh8duvx7U5Sk+S9aLTZdOEIGzqFUeaZOrG2rInBsF1HdV6wE1aKkbBVZajnSgUzFnAbl7HBK5HAs3ylM5uWDWVcVPw/zm5vjl0el++MK8notLQns9tRo3TS/33frYjT68n0nCsqSaIm82iqw8kJpC200NkuOx/7r2GCk0OrOMVHhLDb7t9p+6/dthJvOcmMl8yTOzLFJ5I3u3GbTjuEJK85QeJhICcrfd7+7vHwZIHjyGA/GysPyAN4ebh8fbNJxzGVngLbtkwCphmeEiyzOi2oCVGtJSAtD7/e7hxtOJoXDBMjLCO+5SwZklpEFDO1PAogPNc9kutVxmRPQqYm0R58VboIW570HwQnsVIreYXuUD7a7/ttn6z+soOrOQZIDLnv93ue8Y0u+NHHn2SiPrvZpzewrGbKy3WP4eCVL942LraDuCqFGIiYGA+XTobgxvKg0tVlwW0LquXx8/dvvu6eFv6/tN70zt9t91x7WHi0bmS9V1/5fuc1LlV1MRTmHRjU9dRTkQhi2lgmH+tjl+vNuvf7v33DJwoMWKyw/60Jf4sXONcAfUUyH5AQ4czCc5D71+3N1+TAO6LCw/4O7z5pgBql7M+frq+pf7LgNYrLj8oH/x2ghzQD0VcgbVv3/fDT2su8kCFSsuC2h9Kvpm/XTbKcLfizVdpE+devStno+9HYmq/wopxSmqZdM9IN5vtr+mQxxLSYIoTjrsvY8nLUik2z49mIhUghhVnXrK5N37VXOlJXc3c2wAVe+dZ9uuprRpNSqpe1Y5J06rU6ehPGsGWSLqNwxBd7z9OLLtP3W/rfd3B7Za/dQdHnfbg8uS2TNfIAjLA4B3XJZDEmmhWj5AQ6K34sD6BnT5oA2K8fKG6+iafsQBnfFii2MHhMDVsUUSaUSVC2YIWxUBct4Rdi2anDiNks4A9XBc7483x81DxNAxd4D0gs4AtNve5YCpFXMGkO93+4d14ii+mgvJA1C3PH/pjmPyl7se22dPwpLKdjGrYwUQaHNIGaRZHDvEEHsTDNA3lMUBMSiMJRSkX3SIHWFAZIgHvIioEC94AREhZHn2aJDvdnfd/ev9fufihk8JU0fq7e7OJRxQ2dWYxSkErTVE5Q99t3T7drD+U644CLrEv18PvMXr40dTXQ5ERK7kyI2+tG6gpjxpGRuMK6wwp7wocVBbGtuskPHicoPuy9s85IKMFZYBsN5Ff+zdr836PrSPUtku3UmtOOJ6KSmRbN3UDjqyn4bCDu2odtBRPdUDst5V33bdndxiHDYuPnXOaI1F+kudLMYrDjtjvGysHdTTwSccz47sVEYSPKvOfuoOT/fBmlO5vpr+tOoTtTg2/yy6RFCmaNQOtR+m/Zp4OFjhuy1txYsXlxv0oU+eKNhTERnAmSMFYb4pgKekF47nXVQdFcJrtNU6FlwrvyWeU74sMLxicZco/MNvCRBU1/Cb+ED6r9hJtFkmtadYp8EuWi5XU9YkMGzVNkXFaJ2ZihuW+nZssYqzdhyPWwPQPBfYuqLr9d6xwpubtlFlgRWyPxUEzXdbyoItaDcqCJz/3QMWeIG3ELgAUn0+sLt/hZ6e1skz9+/0rp27V2fo0Pn7cpZubOvBfQIZohC02EUzpU/8Xg4zXXeQv4y3O3UxZwEXtpaLgee5lHNjDFnJBQH13gaygQzbBIoE6BGc7YXRN0I7DObg1m62HzzvLLAOmUVJmaHqIXge21c2rEhRZwSb1EcXBaUDdVttP7rLkvVinJcLQw5jmZP98sWbbDjtoBPNpw44hxG1g80y8HXI+Ya/P/AMks5lChxs45QnGa9eUi6o0HZ1d3/b3feO7Hr/5fXnzfE7tQ3ueSLLXUCqHfs0BfIPDLEP2+yH6Aor10vEDnnRkV6uuHlf5GNRZwQ7Xp30acp6M5zGyYSeKjtvc4xOHrK/nXdX+za2zqtTTrdgyD1USE0aCaE8lswkljyVmATX2fhJZk6efM7TOYVgFV55ThWwbalRjDiYsOhFX1D+7gwKKtCF8QQ1XK3z5NwJQgHNWbOB0XyHOEiggGzAHjynahSUljkFEF9YmTnVW6mJ19unhxngp/V+M8SMWPGd8v2hiBj31nDNOABX/pGaFiEQWnyz3QwxMZv/1k4jJ8G8NktMgDxFqBLIf+y2d33GTKhPpZ0P8cvdw2O/RMzUH6614s6H+Zv15j5b15gLy4qX8DdsloByOrD6IjwPB6DFIscJJ2FVg7hB6gyGn91WaZNvOwqc5rVa4+b4sYn0pplzkbwEMubKA8Hr/idMGt73PnnBGPyVCFFM2fKA8DqOhKDwP4FEwVj6DyrJMPw7b98B5Lms34BXHu4zwIZnmHWt0CJmXFCeY+Z6tTkc95tfno6e05cdrVlaNsTEVEH1QmqigPWE9z+BQ/jGHJqLk/FI4rTrDn4+3IXXdqVyhWllbBqKQp1piAAyZ0zEos/a5k0MuHWUaS52zvFUWyAtoJqSuHWk1R60R2St3NtD0WoP80ys1R+Hj0GVaznSqlb3gPq4I1rtZqYcAA7uZygW9R88X6Kwi34X3Ho9S3rlYS3XciR3Oc/Lh8xep2VKHHLLVycCxh6aORjQws56hPDN6S4Qu2fW5R20d2pKWrQeqD4kTM8JwTc+D2AICsxzgvCPyAMwAkPxMCCg7/mPgVx3gIXM9+alWsGzvuuuL2XPA+ZgE88yew5QT9ugd2EWqJD8OWClgToLpMDb5LLcI5f/Brksd8f5KNBnf2mpOO+tJRyCxnVoCXy3SdAsF2I6bHUHEB14q1N4Dg9gITQHWpyD5VDhCekw53LOgnJ+4iodqF7UWbD67dL4QA3ZoIlB6rM344PTf1vGEyVktez2ZkFq4bWkcFpaie90c7MgdkDCNC7LfXUnVl3QFZ6wYRbv8r3znO+U7LJ+5VRhjFP53nWeNxRDKKFkhRDmz84YIvxYCwj/dylMFIFPUThl4Umx6HIIoVjslR+87kYD1R/870LzAhBee46qj+P30Oab+fLA8F/gmjCC+B0rjJgl3Ywlej1nAZQAJz+YmGUcpqmwNZxNOt4rpZNUwpZJZuVwjdR/DVogGekvuTrCKg5dGpmNTV4XWSAFL4qMsjKuNWwYwxcaISgDVhk2kMFLjBCM3usLG8LAxYUDH7qywEcpvqwwy08Lp5oK9NszmJNeZtvArC5k5+DUpuTNAwAicP/ACSRgCwEgCd1FcEIJ2kgAYML3EjA4es/8+eBc7A1Jzn6uYa7E8yyDxE11+83h8X795Ub+07dakCkUgC7T+WkXR+VzunxH0JxyNuu8AjmdrT41LXVFD4CELemdMDzXcQBEyELOCcHLIwUA/F1SZ/V33bGfTwPrP2WKAgDn3DnNKwBmMePClInz7Vycx4RrpL3AjLusz3vKNZuVNuciMEImXS8ovrMugiVo2qXA6F3C663OPA9zOs2O/p6ln7WxP7HpbXTjn/20A7jr3q+f7o+eDyvqKJY5E6F022HlcXfzXj2mFIIFyZoIxrxY0GtG0AER2cNBaWyF+qZf+OTLW9hyXojB8IAQwGVYRWFnNfQbVHNBvsbLTmqGY93+Qj5fOFSYrRFGkZmxQ//Cqy8vfA1rnWl+hyraw+k4JbyAxwEq83Y3tNak+RoQQIij4Qbh62VAFEEuhhuG/7oeAglc1aNQam1Qq6m0O7x43Lz4vNkdflzv1w/SomhL0vdPW3XSW0dmzZrbwkciuLIn8Tf/9nLsUqSu05DvjL8AXtA5G3oNqzxns5cW+asp2Gz3+Mc/FJcRABA60Rk+dMeL9gSjvt9LNzg1euoD/EJ9QBO3swP8GTxkciGR/Nn/xZN/ue4wtn3qFdXFe8UkfKJz3Pfzt5nyQmYCr/j30kGQ1k9dpLlQF8EU4O4kX6F7/F47xqlLtJfvEnRn2Ku3FNV75t88be8u1CPQen8v3WLZ+NnXvJSzicjfue775tFfPN88XnxlN1Z5Bf4Wt3brM4Km64xRKVJXZ1awaeuvBXSM89JaELOksMOPXzTEYw/2hn2bEOnvhrYkyXWztyWDc5bQmrO04/wtSJkY7c1In/o82kKZ8PVtPwl8CWiKynB5Y67Ve4V9iDTrY25MJpkNvF8DEk093ZxzGH3PJiWY/wztCZ8IgpsVOyVEty5tcvBsX45pIkcLz9y2S7YqaRLxbFqG6SSofdrOpJ7hzbQr5dinQvPE7JC6bXQogKskW3wSgL/JDUYYb1oD4EELmoAy0lI6wdoMYjDcDIYvBHAmqGcAaTFXwUjTzRIGt2ACtT4zzrEGCmSEoamKU2zIbW+vj/unW33P26fGKzPjqfbj4e4Pm8MfNtuP3X6jLnd0iSXMBvqhS7F7AebOC0y8iQu3bIGAIq1ZjBHzQpbBcIXZq1BU+fBYTJMXqHRzRIZn7LbvNx+ewMsevlbByLqwC4/73bG77e3C/0kzFAbgX9aH7sf18WMYVi3XZWCuB+o6DOOU5WwAdVal/3pEKXaHi0/muwzHYq/+yvI9gHGhC7GIzRLwcNDvLzhPu661es7TwCw7UNmaGRbdlNDek2Dt48i5u3RKeNmRMrO52h8ixsJA2mpttfgqAb2dxhbXn02Qdlp5TufFKYPUF1ahwaXAv8Yoc6JMoBAyqdUDb6SCCeAOomdK7c3yLDKkUjwLCQZVfBUlLOcKdEpodVOmRBdaexrVJS885xb6qsUNKUoV6d73Qi65XW8XVC+/20SZ1+l2AXR73Ca6jO42Ak2bal5/7sfhdn2ve+WBbrdXEReZlPyRXPkl9Z++/MrzkzbtrYP8XvtxZxLKtQ3OJcWVw/e/uIyClgj5hWVRniWyFc/h2Hc7l2jtgP63AzqlFHT+4gxd0KZAe0TtlMt77/dc0rXi+d8u6BJS0FmPM/RAi/q8fSUXtYLn+Wre0ERqEN/S/J2+AEJE9Aonl0fj1bD8PgvZZI+YnGzTqV/bzzBhxrY+px33a3x+Sx3QdpcJ8SH5LBm/njHRqTRbgkSzMpZik90FDExYY89gatxiuKjRCZTHOcxPskSyGqJAgZzBJEXJQ+OisYy+tLQ1bwaG2jGOY0FdZR+nXvFqrmEY3ZwzDDPf2DbbKIpuT/5R4tp5wPLYmFss/WX2I8iaU7cmUBFED80g5NmHY8ooDEJ+hpGXMOCCoOcfZMl7Sta+nXl7KaQBPjtNNPasm04hsJ37TzTmfFtRDsDaMkm/7C1iR8qZ/SJLJj8UV+5k/ssnd1luyVqvytKzX7T112j9lxBIDm71/MII2lDKJxVMLfT25dfrPcvKf69dB0giaBcoY7+BCrFsO+rpXn/qsTgW57klRmL4vXYhXCBBuzkZexKhHs8O9ZX70v92Iy1x0MVeZ+xBZOc5PP3ysDFvIu66O9nhfuoOT/eOGNTcAvSB83vtXE7ZBF0ZlrGzuZXm3/n6/8qb7/8n9UAc0/92Q5uAwq4oO29nxPTntUZ3RUIs03+VVfi0X4z8PX6d3WdGxGE9TRy/FnK2INNaGW2U+66YczYswzIuplU5ViHuxuVbZ+Ro49mbd7GWZfba3C09i1+WqeXJLkNU8zM5BZ4ysE1SPrE2RKavM13pUQXUx4SJayyBktO5pjD/VuWazOwNPeu0FtDYHBNcUkuzTHUBDc446WVt9wWb/BVam3tKDGj9eSbH3NJInybTRJJrwgyWixYNBjP5RoKR+fJcRYca4hgkV3lmFp/b3/JhzjBBeAWoWeaAKNz57Hww/MzIzwPa3yJHNeIsVjemUTbDmqtlmYynK1AQpreF18C0lwkQRGtNDQ5cNDvcWvtDzWKhQw2zN7wMxjjSBntDzGd3w81tNMis+Pwtqzfes1jTTEY0pRGZDGdy8CdptzIHfvoC9wn6xDFnDfj0hesM9sSx5gv0tADVubnj+tcO251yrLSobJfh56y1X9GfAzg6sgxaYlTHfdrc3w25NtsPPzx2YOSdo4HXVJXnaHaWHd9ztDcsGjO64YSwic7wvjvefhwT/9T9tt67Trmligav8F+1IyCtDQuujO8GmKDdlwhd1i7YK/5X7RSWVofFS8Z3DpvgLaHaKunLXb8I/uziPtOFtKjuX7hDmG0NC3pM6gZAyFanzBnNM6e7qNs17z6f/h3uWA3byKdmEsuuBNeJBJnuHBnQHdsa0fM9jT9xRg9BnzxR0a3INBUFtibGolrbEG8zHcgxc+AVN2EmvqxhMPbbwB8jTMS0cQbafwZj4QaewWzgzTmbAfFoU6opiWpRulHxaFku8xLbwihD49euBJPj3Rp9B3pM7L3zDNOn7jjbx3UIiKvkMezcbbMN1yCoiUPTZ0PcOQqDAGcacV47+fjgCoUbP5Ccu5JjOiv/O6a50C6kXlvy7uPUvKgR60SXPEpjBqcTVeKATBmHTmyZxl74kPNBFj/M0vewYK/PvXflAOq1Z2X2/ax7VQ547j0qA1vGvaklMG29826/vou5A5/Od5FVkKP6K8t3/7WRpRCL2Kjuud+t727Xh6PMeubWXS9qO09jcxCMuRsbtBWV0mooZOs9MhfRulnVv7LKtZYG7Tkl6VsXL72RcBFNa/X8K6t5ambQ1lGSjmfBWq7TUKWcu+1GTf/KSj41NGhrKEnNmnDtbpFrW0hLeFnHZ2LK9T9EuDZ9Lr2t1CIzxnmhEaa4JyZgBzkYPvdaQMfOrkGIAycQC9yoKSIIa7AttKCNtHYuvOiQ9tnagakvPLh1dnrx15hhPmZdCCHrgPdAnTT0iUbkNwI+DYk2B3GtCDUMPk2IMxFx+MONhU8LYs2Gfxu03Zk5te/2zDJD8v4MPi6Dqr9KGILOHQNssIWhix1XPpsZKbiiBovX2T0wLMJgRY4A167KnNBGWc6JLrOvYlaXurFyamHYWHMDSxhfIcPKQ0KRQ8l7BLkhRI2agMHiRhA5QJL3Q5a9NfOGiBOqz44I7Lo5t0ScAJ17IgBdvk0RDJq5Vtge3hN3yTn9FzrrpVYRDgRX9iRB6wtLOXYpeuyTyNwXaew1Vu05m5+JejtP20O3UBKFgAjftZdywZ6xqPP30i3Mhodus6T2CSB2637LBXuDWeHvpStorQ7dikntB7rA7XsyqqzLCARW+XvpCEa7Q7drUruCKXSn4+axdaOlvbhrppHh+t/inC/Fg+tN91jUBppNK+B0B2rRBF9aN2sz0mb70DZETV/2BiRMUKHoI+2uHX+SZfVoAWUsPDeFYIbLmw1Aiy8+RBqQEyO+kMkZTIlfIzIYFbpZ5zIvnk1LNDTR7YozOZ6NSjE+0S2KNUOebUozSEGtMvea5gwB203LPDl3nMxeEwriKnk0++8+JSJNG5yeO1GJGBPGmu+uFBhSwRCTho7HDtWc1sEhz+kutk9l1phhq+rU1OBx6oUweWwGDkk/sSUNw5DR5wUnYcSFDTQvNEmDK8fu1rKP59/gcgL23OOCvT3zNpcTps9OF8CYdbMLA6ithH4+RO11kdkusiqy135Ff/ZfIdFl0BKjmeqXT/uhiiHrWVt2vajrHA3NQUvmbWjQtlV8i6F4rSPKRUKe0l10zEwcjPbv8FHRZ9KaSc+2wf2eRJfQsw2wVlpoTuZDCYHEl1WivoKFf4xQ55gTtj+nYt2IU1SMN8C+0J4S+y6yF+lTF9iEHENqv4qXmWuVNaWz+S5TmsusrozaUldWc/PClOOEFa+QZM98IZ/MXrkLqI9HbmLM6o274Dk9cRNbPi8cAaZNOn9b32/uBicjwg23573IlOQB4cqRxn/CchTkECXtn88ZL9TWa1DneRuew18/T9OD/PYcMjAFb4kqOZV2Kbksav09dQqz8UERZ1m6BRC+21C7Vncg8eVN8bSSgn+MNLZ9Tth+2nGKMad2vGkGcwneY2MxygI4WpE4xn3aQXZYnzUtluMrdF19rYh+ie3EY3ZUMJm7s2cbEju2pUFn6+K+LUvt7GFt0xb2Rg7f1T2eKcMSf9l7ggFcJXUSrz1fpCuEw0zUuIuRMBLbFnJGwstwE8sqUwkKs7Uh/csPXlKfCuxKfogSu08yf4LrMDOJ4gXZh0lB0GalU7yAOjkVBGU+YoWCqPlAf1/f33fHCGrFkvEiHpGr/itbAn//yFaKTXbWY1oq49nbdw1qO1djcyyVczc3iDlJa7cpZppEu5TW9ar+1VU+tzWIEknU90nALmX/eX2/3t5eUg6nGn83qh+bHHT8LlcPmMRtYUqNhI6FZA65oHX+q3eGZaODjuAldgdE5M4OcdGe8PvqArPu24vqnqDFT2W4OHE95YV96ImXNf4S4yX32YwGW2OfwzwiC8YETxcAdp8Rygc60lGLRBzoi3gBj/I2wvDHT6G2FqROkrFtyAw+N2rcbPnsjCySX9qA6az78s9RpmzMu5RETqPmgzvFvFGNyG7ovBoSa/JSWxFq/MIaE2cGI9uUYBC9WpVsGpPbdbYGnbEl2vbaKbnv3hqSI3VjDbVFYbVfxVsdn3OeadgiDYk/MGgxYvFF2QavLUnCCAQCTR3uAVAzYMwATt8xPaW07dGcUl1mrxTUl7pRqjUyxFj4AIs2EP52wQNGpC0INgEhUKKGfcRo98CUOsJDBnYQnHgccfvXyLjKvHntBuuzcw1xZt22dkN07llDfPk2rPFOd9K0SjnIY8b3sLt7uj/hG74hVvpUGj8V9+cXb1/f/Pji3V/nwj6t95v1L7C4OZ2X+Zfo0Ppe/vDtt69fvnvzw/c33/zw03cv3r11VLzMEIPAuqwOqvjKbxlNFEGO38OnJDjXqoAYSEtH3kB2SEV2OBeyYyqy47mQPW4etekpCttURB50+tLsp+6/nrrD8cX+g80XlUVrSWMGnSGToaLA6q5UHrcI9CYR1e8e5Ro6GMIpXzQMzdf+c5/sxY9vqIlFWVqVJkbggX72ojrSy6ZaPLUnxStBUXj6JJG4XA7IEpKX+xGJxuprLKG4PY0AHFrfHHrvZt/dvd7vHV3GSHmpfrqsNLi3mi0ktPF+093fhSKZMsVj0Fyk3fRg+Ntu/6nbf7c+bZniU8kyQ4xSFi7m7e7hQRu2wMlUX33dzFc/f/fd/72RTuTPP31Lt2cs1Uzu1ZoRLbqPM2TbH+XO9evP/dLLQq6OABY5kjEcumPv0v979+Xd7odf/rMfp04Mixw5MPQ2YHP74un4MQTGIlMWJF2ffh8MZZErB5YfQmH8kBvB275dtx9lh3P3TpA+Q/39MLzf/Hf3an1cv3n/fdfddXceKJBcyViOu2GefXvcb7YfnBD0xMk1KyZvdOK+GWt0QkBzRWIJ2vt11n+Ff/Jbv1pLxyVlnUowR3Axo2iJrBOLvpx5qeeS46E72q+lNOsh8ntqUG8W5d5JG54Fz9Vclj8sqkByndYPa/kzC2CttPNBfuwL/m23v8sDWSvtfJDXtz24w7vdr902U88wCjwf8MXSKQk1uqzKDfkgveI327vucx7UZoHnlfUPTt4iUNw/+BEaScDf7/YPg1Pw0n6iNQA5KDErdH01CibdbJi9Z12f0g1h4It5Iyu1mrXUljT9BS7vXTBC1vmWsjzn51BwyVOy90QciizD3Os944ZiyzDJhkytwUrNMpvG0o9OeBmmzZDJMhRenvkxZFaMEWD6RBg0/YVCzDTj+c1zKeDSpzZqQjMiLTaHfzvstt9tEgyiUUQGgcJlLrGwtS9ltZlysx365R/Xd3f73vr8sft8HAz4/c34h2XxY44pwQ3MYa1ZdxdejxlfgJpmCTtrAiU4/AdnUyOciSiIcXFlLviwKqpP//K0ub97e1z/2hujjvLV4tqFFx2pjqD2/NwL9GwtQgq/RJte3q83D2dUFF7+mVsmJTnsvpAxfnEtQso9c0uetudqC1rymVtzO3SGM7QFKfcCPWyz/fBT99t6f5drVrlalHrmVnxSN8h0L9dbOURztQMpF9nT33zqk5y7XaNZPUPLTiV/rbadbOsZmmcUftEWfuiOb9VAoOOh45qHlnzRts3OS4/hfJ4RKPyiLbzdPX4hF7Gxnqxe5LlbY92rzNeSa+33HwrnUjO0QddEVdTKftsdf9vtf32DEF9xTdULjA0dT9Ci0bhNtlZtvlJzoIH8Pre6QJkXXi72tWdtytdow3DyJfeEBcq8vFYyO+of8KNTF2nN+/XTLXbyLK4lc2kXbsVxBwKIEtuhlXeBltCU4G/ybJA/IWim96YD1REkbzIQ1GLkDiQCQQMz0IBOcH7bi3agZrHUBNurqbvPgXgqKMrJi0H+K7ZBGo77V7BRmh91pBVwQ0ctQHbE89FZn3neDdos7oy4D90R3UMPhzyXdEa049u4dz4eiBuxUdr5UVOPAUcDdz0RnAO765nnCKPt+fhzplH5qjscN1tJFYyJX2zvxqVAppHqqOJiVvN2vX27+eBBt3goaS7qEn3rzsMBD+hYdwE8QyLuMZI6M/xTqRfrO/o78VmbRRV8sZZpnG+2roaUeTGPLoDJcjfkHCxWTKN8GCx3a7KyV5HzTQBz5TW5ZGCtIluSrQmXxh7GVPm5W+ksVaQWvBkqL1Uks1MxrfBlptwtSGWlfNGTPI6TuPFmanw5musoOiYD/3JteicRVMt1tpnsOmLSSkHmMR1dh8w8gVji55Rrv+kjEU8MkIwIguz7tZ8pT5SIr5VeiCU0oseFxdPWXrvMagoGb/bORBFM1GE4EMv9uLnpjJsxlrZ7SuJvvX98Q9y2sSxzSutrwWe8lIr3u4e4yq/0rL4w5iKS5hQCUNi0YoNk2O+Px+Pjy511rUcA0nJmQ9OnjANzypgTy3f9kFl/iINzypuCKNRaEHgCDIZVPtq4/nm7eXi87x76/OR9OktYy1xfZawTMIhR7+c4WwrPYw8o0Gnh/X6wo20GBRq1HmdDHGBXKMCYhTkn3gDbY4GMWaGcqKPtE4U5IQrBU86GDVs/HT/u9pv/DjJhINNXsmAYilwGDIolk/1CIWczXzToBOuFQs5jvDzxBtkuFG4W0+WPNshyUYCzGC4ac4LdQhHnMVsWGWtW6/vd8Zvd09bfYhkZvoq1WiLIY6lMUWSxUgjUTBaKAhttnRCoOSyTF84Aq4TAzGCRfFEGWCMcaAZLRGGNtkII0hwWiJSpZn3ebOWW7hhz9crbBGD5vootIoHkMUmofLJYJhp4JgPlgB5tp2jgOcxVCOoAq0WDzmC8AjEH2DAr7AymzIE82qLRuHMYNpe8l/ZtJMzDDZyZ8WtaOARJVhMHRJTTxmHQ8xo5EnyqlcOgZzRzfrjD7RwGO5+h80YdbukI4PlMHYk91dZhyDMaO1rmlDcX50J9dTsHYZzBjzuXF3dmH+48Htw5/bezeG9n9N3O5bmd1287j9d2Tp/N32OL9JK+uhVb4DiHr3Y2T+3cftqZvLSz+mjn8dDO6Z+dzTs7s292Js/srH6Zj0V72D1tg70yLddXtWcARl5zpkkmqzWDoDMbMxR2si2DoHOaMjfiCEsGAWc0ZF54I+wYAjmjGUNRJ1sxiDmnEcPlvLRh0+nVcCIN5PyatgyDktWeQSnltGko+Lx2jYafattQ8BntmyfycBuHAs9n5/xxh9s6Cno+e0ejT7V5KPaMds8i96Xt+7GXVqipmfN8TXtngshq6U4yyWnjAOC81g2DnGrXAOCMFs2JNtyWAbD5rJgP1nD7tYSbz3JhiFNtFsCb0Vqh8l3aqW83D5vgZeYp09e0VABFVlOliSWnrYKQ8xorFHSqtYKQM5orN95wewXh5jNYXmjDLRYCOJ/JQjGn2iyIOKPRwmWsnyi833fruy/qzWJvg7HM9XVOGeIw8hguRDJ5TiISoDOZLivs+NOKBOgcxssfcYD1ogBnMF9BeENOPdKQMxgwK+r4k5EE5hwmzC5nzYZ9t74fHoTq7sZrnrztB5rxq1gyGkkeY4aLKIs9s0DPZNJc4KOtmgV6DsMWhDvAtllgZzBvoagDLJwdeAYj58IebecsyHOYOqfMjXOWh6fHx92+L/VFX5u/tUMzfqXzlhSSXGcuMRFlOndJQs929tIOPuH8JQk9zxnMANwB1s4CO4O1C0UddB7TBjzLmUw79oRzmSTyPGczHTJHojeGdBHnB7RsXzV+A+LIG8ChCydrBMcCduYQDhx4cgzHAnbOIA4PzBFRHAvIGcM4/BBHxHFgoDMGcuC4kyM5FqhzhnIQsl5aNO327lBrArN+TcuGYslq3RaCymnhcPh5rZylAamWDoef0dr5Yg+3eDj0fFYvAHm45SPB57N+FvypFhBHn9EK2mS/tITTXaHB3p2Z8WtaQQRJVhsIRJTTAmLQ89o/Enyq9cOgZ7R9frjDLR8GO5/d80YdbvUI4PlsHok91eJhyDPaO1rmmrX7qTvsnva33evPH9dPh2PAJWl4zq9i7yxQ8hg8QkpZLJ4NfCaT54QfbfNs4HMYvTDkAVbPBjyD2QvGHWD3HNAzGD4n+mjLZ8Oew/S55a7Zvm/kTd8yGOWnbn37McD4EVm/ivWzYclj/ihBZbF/VviZDKC7AdEW0Ao/hwkMxB5gA63QMxjBcOQBVtAFPoMZdOOPtoNW9DkMoYfsl2ve4ZW77u7H9Zf73drfFpKZv+bal0CTdf2LiCvnGphqQt51sLURqWthqgkZ18P++MPXxBT8fOviIPTha2NLA/Ktj61tSF0jUy3IuE6264A+7/r2uD4+BV9GguT+n3DuFcI5y9lXXWLnOP+6aMR5zsDizch1DnbRiDOchfVoQbi1JBuQz1yG4Y8/F4s1If/ZWLwVuc7HLtpwhjOyhB70m8wVCflN1yfcd1qMjbehspfwVWynB6RMl5/bpZfFhvo0Jtf16L7Nib8v3aMxWS5Qj2pJgE31aUgGuxrdjpA71/2akuMSdt/WxN/K7tGWLNe0e7dEG/ZTKUO0z9yY5ft+w2fEbBIn8YzClpKRhb0gikTbKAu0WOHv+i5971/jlZ7Hp26Vl0TQHW8/htQ+pk+v+XG/eVjvv7zqtruHMUwhAAeS+w8sFlf4bALhOCYM63PwKKTgt3IhIvyd3FgEMklQ/acc6bX30j3u17fzY81BegE509Hcdbd937sPgaFl+R84cLKgOu5eHPsSb9U1WgGAFhkzGLXeREaiQbLmkI1zxl1Kxft5S3f9H7rji+ABbGSKw4DM1U/Hj33eze1at6/LOVtP5j13vxyzv0ArWbbYqATN7DvHGxWmzCuekAKfznWXavF8/737kgHwXFDY3BiPfCw2D3qjsDO2wBi1WtZuPJGYQxFoqVl7kNGKX54293f/9vd3GaBrRZ0Pb/dZOgw/dg95ug4s71K9Z7uzP0nvi38q55y4l/PEL+v7tY5/MUOMCbznhj+DAhcCmQr8M1kw1tAJZ/z6Dqs3ZI0H8juRvNjeOX0BOyajhGh05jTjcNNQQGtPB80XQ5RUvJc5IShiMCT1FHIA3jysH52DcEgUOhC/08qlWinLPaUPG5ISuWUwjOVaVnEWFFegBH9IWknkvH/n7oQoKJUxKxb3ysUGyH8R40a17KLTD7p/Tj+CVxB0c+ciX9JlYw2cwdopHkt3xGu+0jJ6QpgL0LDUVcXrGczNzfHLY7AQZijXKv8fighM13N7CEH9uU/0tnvc3W/W6QCvzdKiwY4F2jB/t95stzbTHoT5VNq5ML/ufbV99/SQD/eyxHNj/+uuNwe/Wrz4YOynEs+FXU7m4WZgzva1jYACcj3nDpbT2BJatWmQrlUJkbAcyvt7t0lEp0o4D7q//JYMbyziPPh+PtzdJuIbiziXdpM731jEefAN++P3m76sCPOhZ00wIQh5+KMHEUejggXkwvY0zPv7T91eRkNaKFkC2jJ/AjLD5b7dbd9vPjztu2/6Nca/HWybOwQ2rIRc6La7/cP6fvPf3bhjHz63LgvIhe24czIbBCg9ZwKaYL6fVqA/u+8tng/d8VX3fv10f/z5ENHjF9lTcGGrub7Na912Icu5MYl1PcdPhf/l76/f3Lx6/fLNdy++fTuX+2m936x/IUo2sniv7SboKIqhxB9f/3Tz+t1fX//kh8LIkgfFi3c/fPfm5c3P379591aW/fPbVy/90KBZE1Ah2pdRQBbVq+/e6/jpHqAf3/SzxjeDxbEsYMaykTyebRzBEzPNq9ffvPj523c3371++/bFX15H47haFuSFCyswxWa5YAYZLy+IRnzW/sPTQ+d8QnAs10j9VbS5RBCtR7Pp6RpEoMXojoJljsdjt9+u7/20ZqT+SmMQIkgYfXrTc4y7BbS4EYfDQqzoy9GddEQamUPZyPQ17egSSKohNeWRzZIiQBNMKQUS0e/P24N+IswXL8j2NXWMQUnVMpRKNj2jYBM0TQNF/Kz38pj0zXE4z7K+NQb0wudapvX2v9Rp7HdILQvhILUscnv2LaRxCVrzBhamPJ9iqeHxYA8l8Ef8sIgt8AjqCEQO155aqr+uDxYizb8ZaKl55W9pxbebrYX+iG3FWOoZW+He0/XH7r/DG4p4absOkm+7OZiE3cJsGcm8LZYfGWiWrefxNFFmG5xETTSSK6OMEFBGWZGGyAUuyvx4oYRytHGBHiL0IQSjcP19fX9v3ebzAHcqIztCt4lw4fM3DH7oEHNwXPffPtzsHjuwNFmaBJjU3yyonD8s6lgKZFEHzOtrIhbtSnBiPFGFuTDuQmPthifaOPsRjVqbs2wj1hM8KO18bVjYwlfp4KdicvYQi4uVQdzLAs+JXd2t8rfd/dP2uN4Pr6Ydx3O+eZpiL/+sLZNXH+RpxFTU2fBuDu+6/XC87X6oyxLE4ot6WeDZsP+23tj8Pk/AYylnQ+k4N+wL0/M4cTzOwa1IhzmWkhUl7dHsu9/W+5PjSrozKl2oL/OTWTopk7F0I1egCzM2hFDN/cZ2oMkJ42rMH4TFLCeHZ0Xji/KpHDBjvCkaYZIfFYJUhi+lIJ0KODvS947NYjfUuYRzYDUPCjhOzXiI1fMITQy6O6+Jl8Z2FzTPBslNXQZg5QbcotMKOQNGjxW4E2LAGtwT4XLO6lczd5YTGPKz9wz1zihs0WJV2DuiSKxdCl2ClYdVhhl1LXekDV/UH2WyPXBgO0JuNGau3JjWj4/73afOaxtpAQ3NnAFhCMO4AOVJKfrV/L37VhgMwPf+F8P44VA8ZCgMLVcWFC/cRh2D8cLfjPvhGGJunWGoGBIzYz4sDieBhOLpGvgheecOzcWAvPOPy/XGESEPLVceFFEWbZExz7hJMbJU/izIXIwThsaXWvJAYOdhFpX7ES4e9e47exTOouY5Q3rdbq9z6QJ4O5lE/ahP6Y5OiQlL8e3kc8HhMSiZgk9sIIJ9UKykeH+UxhXrm4bg269/i0Sncp4Tm4rDioQ3Z86MEFpV72g/K1q0oOSeiO+mJCOFxWTH6R3a5EIaHM0UIVP3rGoXpv8MG4JM3rvn5cLT6GAZeRF67ylZMQZvJCX1RnuIWkBv9ItKC8TaW+TkGflqUUhejPb9I6dFP0MvfJsyy2jZ8+Ly8hxpXEFepAsX4VG+t0UNTinCfMn3tmDBuch3dNlkC9/TwVkel4rhVYdcK7YoIcVhXCKJdxV9MPmSmRiyNEqTxBdIG2LI/MlDbxR+FCIBJoxI9MbkRScSkIJIRW9E3wT4JigsWEBGbNoj70kQiXIyIvUhAAlwISSgPx43EUjB8ScDvdGELctQWHELMk98IUsxFF3MIswTW9jyC0UXt/AKx5eILSOuw6SSFHREITn7nc9yFe9wIQvVcE16LK1c2gxYVPng8yCOMUwB9LEfDs+lAOJ6hS0CKCyI+//lsbNcLiE/Wx1/tmqbotIu0xgmpBc/vlF3Js0ly4JguWZa3zWARHwCYL2azbfaK99L2bASXDN7LJprrYAIWMsrsaCu5IbDi+XVWChOkPhi2sLqDVQXbCehr1/2/Wi/XR+O74xgm1BU14tyYkBi2tOvwtp3/VorEahZyBlQKqOeAlEr4Qz4hjhZmSOi708IjTJyYTTHqVq7eRpVkPhi4xSrN3CcwnYSHIbqtipxNKZrUEoMwKXmsorNgBhwc7ANq9lsQsAzXRAPXS/if6JoZ3yTXHmiXE8NttgalWJxv3owerSsPGLGOSf4RkS8vE8lnQHvSS5ZhJtTqsBLVkSSr58MUl/OU8YqDvWVYVPJNZp8cUfdfPDN0/bOoUIbtmu0sCi47hECn94LR2sUcg6UQ5ces7jMjhUoLOe8EvUyOp6CDTQ78fL1M+6+Ug4174G4lTOQ3oFhOdmwmlbz9Wd1M1uY9aRyXcyKWgEEWlNSBJaeCfL49VAf0Nf20pMa5LYSeMUZWmUr+5xtGietKbf3TOjVKGvh2VtljtvhVmTPwWokvdgIXdYaOCzNFtJ99uXTfijAuGU6DNH1opRwgG6NDcfcOk+VmWkvpjOk2kClgUZSrODwtCJ52U0gtGuqtAjA/hYyG3p7mWdpw1jPy9322H0O74ka8kVJ+fHKOxuMI6IO021BjJeVCbM52v82XJY5vDzpOeKX6S826omqA0c+0mCL/zSndijTju16UVQkVPeYmfMk4QUFZUS72IWSG5WenW+R/JI7UUjN4XtRoLUeu1FmOGU4uGussDi4vvtSyZAXJZ0F7xR2kAjWLOYsSMd9JpnHvV1lwQoLyocW+JDafYW+riSW5XIeJVl7qGOJttyiVz2Dy2NwgbzGCoyH7cFlewYQfIXYgbSwATRiAD6V5TAbxKbxU8DSzbZTbKD5zWPPjsDzW9BenTeitReziENaB7KJvpgWBx5CQB0DjXwIKleYBA3JPzzCG88Bu/Q5BBYoIDO6YYETB2vMmRfPJz+Hm8D0KdTL9h9/HuFnxOgLijvzxdOZFGIUsmUZyRiXR5dAbG23fXogvSyVNnJOK04T2o+vv3/15vu/BFd6dcoY5MqNbUSx/PmnH168evni7btwNHrWbHhe/vDdj9++fvc6HI6WMxuab168+fb1q3Asc740JOitDd49Vk9+yU67qDeq3xqNTe66S0xxvdeNKqADL0FF9WE3Ju9uvEQU0ZMJPHis46v18fSGPTo7nNJdOMJxrjIquFE2zOq/a+fAAlBca5kD4Tg9wS4O0ZgxGc2SV+ju3P1jSnVB9kCrMJgwGJsUrQOs9iANzAU4PLjt7f7L4zEKjp43J6b10/Hju/WHCESnnDnxbD5FQJGZElEsmBnzHCfuZcs0kaMEVqgdlbXXqiWMrBp/n8jHC1qmv5AbRFQc6gch7UUxvXj57s3fHA4HBWnOm44In+BfSnb/h8ehB3jF6hoZLjzlL+uOmvvNNhPGY7u4dyAG2PU24AYCskAHZbV56HZPx7fd7c4ZouSCuyjrTJg3w9uun9b3WUAvC8uHGo6a6aV4rxEDEl9stGD1Bo4U2E5qyn/c/Hv35fvhH7GIro0yYsA5+tp4H0pfRzxGo4wzYHw6dOjzfsFAlwWdAe1d98vThw/6+elgnHoRZ0A4pPxxffwYD1ArIQ8+ypJMzyB3wxUs/3bYbYNMC5X74rbGCiTS+JCiIbT+fnMfoHUfxNdakVmgn8MOeDUk0TBEtifQUni1JNp0RLYhzJZ4NSHWuPi3wHxTabJKw81qjoUISJ2+JBsfOY+o9uqU1T/cUm8pvkR88dO7Ny++jcFzypoRz/cvPJaHKJw5ZyqaxdRkhHz5zUdYlstNQmTtoTMP2nLK+fWgdZzIrn0fOLKV57H77FrIegA9+F5xFo30zpe3cqM1izob4pDFtxt03PI7BnfQAtwNPHIJ7omctE93nuvwRfrLW6a7pNX4ssE5bBKKKdYg3Xkuzd4jr8/EwHwf9BhNHNbj4k2YGKTHgCdiInHGWCECbJoJ8kUcZ39wyKnGx4IZuanNiDVdXNQ2fLXe06Zf0GwcPxxTg6J+xsvDWiWBnSoKftDDrC/sCY85L6Vvxx3MoO6ou5cxDMiZCHCjjlMMQdcTOTE47lUGlXvep+ysFbuPxVV30PUrPu0OFHzAzUXO2jcPj7t9KACQKRWD+85JUL//XZNo3YjlOm7uLXdMys9W21Xrnvr9+sSnv3/aqrfrYWkyma/9kvDQ2vrEh466f5isHMuVjuV+9+HF4+an7vDYV9m5UZjp0+vfdx/6kdntX3ze7A5vhqnvtns0DkWSUMis6aj62eJTtz+qHvtu99fusxvOMk8kDqSvLyPBF/19TuI9Xy/Pcy7G8KnQv1mKxxp1Qmwx4uEVe75BjmS3Hq6OADLlS0IS7NWQcIL8GzuoEE+HxBPl8wSoTT9GbHNBSICLAvJ1KY9btG2wfO/RDkDknq1JQP7ztgPP0qqBk2ULk6a+e9szl0M0Fvd3qlSsTb9Zb7T87sX/d/Pi1aufXr99+/ptSMVXMKcXjGvfqyAtHQ/BEuQaeyFx2FQEg6c19apdebpB1c9ZctSv1lhB9c9ZsrR/a3tHFWv91uclVarukOkCqTxqovDDsh68wzAwU5b8aIxgax8sizDrXEjWiysbfeDouc6GadhF/nHfvd98jsFm5M6C0RhX3edguzJnyWdX4CFHf/PifbTRC83wEkl4l57y5ECAXJLqAyLkWlTveXd5DarvzBtw8WlALzHvx/fvI5634nvLZXErpK9Y/C989O0r8CZHz77ifUmjLw6PJ+BwJAHPv/lisRxy8ASFlpAJXbiIssnmsP7UhZu3U6Ys42e3vgvGoGXKpIVX3fv1032sqV3kzmLj1tu31mdiMfs258mywpEXnYYtcaYsWa2840lUm6H3vHLEC4+bYECQ+FMLXhhG/iF83IKM+T1HecHlZojg+TDUETyIYObzIFTnKDe7rX62wBchyJwfobzidHwRIcIUodnzo/xtvTl+s4Pxzj4AYc782Hrv+zu5vv1+F+gbwpz5sd11fQldaMfTc+XHNK6ajsfucDSD+ALWXEbu/BhdTxAiwJDnB1PQaLTTnbZNNpG58q9WCrcs2pKvTlQAHN0zLazdSed0J+DdeEQlo3P/rb4XZanPTJ5WtW+diZUd9Kua0GoO1iuZXBXAVRVWhXMJ5azEePruJ3XnvL1KIkcGANJtCsUAMsXCwK759oJizxgJ56VOK/nAIDIkVa8vQP0x4LmSgHj3TTR5atXevZLKkQRATQv+1cP0+SoHm4CeEFxhUS4gr48fu3339DBvfH7XHdd3+m0yGBBbrkgg6gEO7IVpDACWOrbiXqZPe/s8cEoTXcni8nq2Wi2Cl/C6HVnzQfIZBtZskVD+Ah8j8AFiyRQJYziNdf96v8eClbSKjWSRVX3fz2Ofun4YEc85YPXSeSJB/LjeHzfr+zAUlkyRMAZuQFq2fhi//tRt7fVjqXNV3A+qp/vA6uc80SCQY8Z4zT6nhkOq8xH2MnWuiiNqzw3BuZKhcmQAEFR3YrV9GXL+ChhlVJasEHzGmz1jApzu7m+7+6ftcb3/8vrz5vhd79ivP3Re7o9X9lho/qY4mwE2ygmvOReA5XtMlro9HloKrVbtAr7ePj0EATCyZYLi1w3pTGkwlF/nU/ecMkeFgyA7X/Evs+SA8M1u/7D26vsgfWTlZrQDVp0jrsGrAudco6eKr8hr5ZZlzba4QNfZa6gc6QDe6WePHVW/s5419qr0vcNNdG+P+lYTIlmYPLFqnw6rJ4yszjj3iVVjf1HSVfzymApWh8ebYt4VvepnAPRsGVbfKXFqtU51wZSRFXpQZKl8mMq/jA1yDgNHxiQ4TvkaydJ2d7rDi8eNPJjWr/TXD9LtdvRgV84MgL559EYgk+aocj0cSfriX++cPkPl8lDg+7Vje4rKkQGAd70J1Q37dxG9zZYtFYqrnxnpkivz6WHLxKnVevYtLHlq1X41xlcEnuSOsGW+JWQE6OhzZJacEDx6oj1fRjB+/dOVMyOgYBx5GMLwzuuTOxMwR6dFk+eq2qOz0nkygfDrpLZcmYAE1Z/GknThHdKSKxGIqwPqyVKr8ulwi7SJlXp2MCR1YsVe9SUSUuGmzZotFYqjL5npkivz6E1I4tRq/foTmjy1ar8a01mjqF5lzZkBkLtvmUlzVOnXw5D0GSr37mdojgwAvOtN4w3DO5stVyIQRyczkqVW5dG5lmkTK/XrVFjqxIq96ouvZuZFw3uTM2sOSI5+tUybpVKPHkZkyFG9X18js+SA4F9zfIXjvSnB/c6eLxmMo8eBhOnVefQ1LHVyxX69DE+fXLlnnfFVTe8jyLAE2UW6Hr59X4rOkwOEf9UpFaojR4u6TkeJrrQ0eC3qMFLwHphWhWMLzFUBdYpJq8F1iMlZxQE726NXcLAd7XEVT53s0SpwHezxrOK79dJcLWtRqeIq+svfX7+5efX65ZvvXnz71lYXTBjZu/pCfnz9083rd399/ZO1k4GEkR3h3Q/fvXl58/P3b969lcX9/PbVS2vHIDLEVf9mKw9Qv/jxzb93X4jQH61yPHlky/cfnh76pHi4ud5ikDC2pYqldlYHEyYJ1m6Bl5L1s8OelVPX1NLVL3PEAXAfZdHq9j/J4qrWGkmu1egVSO6qDA9c02qxx615FO8jvBxiI6OqYD22oCqvGa83HC+VD+Ga+vSUCfrpfThVjHU2XyZN8Uy8GrlMmuSr+Al2mTauUrDj51W5JU8ciIF78KoZJoy0LZL396lvkTKuwnmV61UpmjrNHHjViyVON95+ciYyRA4kL0uRwUiY0aI+snXczRUwk3jWCRKnGMNXWAj/wg6+ssXsuztOd+eqRksT2T3M14ywrmF/rMhVwSvkwTGkllcej4mFjDR3jwi4Jc6vS+APvZN9AyaPq5p6LdtCUOSq0vmsrgWDJW/CNIa9wUlNZGbaSElYX3HEmk9kSKx++Uibre675B6ARtcDzySXExbge6X6t+4K6cu6Qvuq9VAc6KteZ+I8KyUOgC1rdJz/8vbyvJw7VzX/8Xz89ad/PuuN9mEQxJ+esWt+3fap32+6+7s+5z9U5X1Zu4eBWHn2H+O3v3W38vmWP/1DJfnj6tnzf6ye1+K6rOv/+I/n/5hyyA/yDzJZ0f+reF5V12XDjWSFkYz1/2LPqx5Ow4xkzEjG+3/x52V9XbalkYwbycr+X+Xzqr1uW7PS0khW9f+qnler69VKGMkqI1nd/6t+XvNrXpnJaiNZ0/+rwUprjGSi/5fAkgkjWa+Uf7RYstYU7yDtYoVJrgCKkJoosHYUpi4KRrWkMLVRcKothamPoqRaU5gaKSq6OaZSikH4BUPLNPVSNFSnKUzNFIMGCo5WbiqnGJRQlKgsTf0wqZ8KGyfM1A+T+qmxocLAWBm0UDTPS3G9ahszpakgxkkhMVNDbNBDIbAxw0wVMamiXpnNdQmKNDXEBjUw1EQwU0Ns0ANDuyYzVcQEWbmpITaogTG0SFNDfEXaFFNBvCC7BzcVxBllWDgwZ4MSGMdExE398EEJDLVp3NQPH7TAquesb1DRmilNBXGpINSycVNBvKEMKjf1wwctsAZtkKkgLhUk0MpNBZWDGliLmnNTQ+WgBo72uNLUUDnogaM9rjRVVMoph6G1g0mnJIdlaaqoHPTAUbWXporKQQ+8RFOaKiqllavQFpk6KgWN09RR2VJDozRVVK3IoVGZKqqkilArV5kqqqSKGqxBlamiSqqot138WqxAmaaKqkEPvEXLBK5BRTW9MjVUDWoo0T5XmRqq5CBC+1xlaqga1FCixqsyNVS11MCsTA3VgxpKtMvVpobqQQ0l2uVqU0P1oIYSndtqU0P1oIayRlOaGqql64YakNrUUF2R82UN/DepIoGWaaqolirCppfa1FA9qKFaYYKvTQ3Vgx4qVOu1qaJm0EOFar0xVdQMeqjQ4daYKmrkTFRiQ6MxVdQMeqgqTJyNqaJm0ENVo2WaKmqkg40O4cZUUVNTLmcDnOyGcjkbU0ONoFzOxlRQIxWETkSNqSBBegrC1I+gPQVh6kdI/bRY1xSmfsSghBq1M8LUjxiUUBdoSlM/YlBCjc5twtSPkGsgjglJmAoSpLctwDqI9raFqSHRUu6UMBXUrkgnqTU11Bakk9SaGmoHNdSoq9+aGmqlhlBz2JoaaqWGUHPYmhpqpYbQEdSaGmqlhtBu3Joaagc91Ogk2Joqagc9NCs0JVitDopoUCvXwgXrigSqvulpCxKq+qanZSRY9U1PO+ijQU2t+qanlZ43vsAGi9fVoJKGI9OH+qQnlQYPX0GuwPp11dAIwAp2JWgEYAm7kipDu6v6pqWVVEKDrhSKBc1QkNNDAYkGySfgrn0BuQZJKTSoZ1BAukGyCrh7X0DGQfIKDd4fIecgmQUKL9CaJBca1LQXkHiQ9ILA+y6kHiTBIIi2Ab1JioFgcoDaJMeAczkM0kOMmloLwD8UioDA+RzAQBSSZxD4oAQcRCGpBqJhQGeSayAaBlQmyQaiYUBjioggGgY0JgkHgU6eBSAjCm4ZaYCPKCTrgNsFQEgUknfA7QKHnB6nZtsCcBKFZB4EulQoACtRSO5B4OYG8BKFZB8EIQSgM0lACHSGLAA5UUgKQuBDHdATheIncOECnUkWAhcuICgKSUPgwgUMRSF5CEIIgKMoJBNBCKGEVKxUGm6XAE9RSDaixe0SYCoKyUe0qNtZAK6ikIxEy/C0QGmSk2jRlWsB+IpC0hItPqsCyqKQxESLd0hAWhSSmmhxXQDaopDkRNtgvQHwFoVkJ1qUuCgAc1Eo6gJlsSvIoZP7GgUgLwpJUbTYgrcA7EUhOYreQ8OFAJRWKfOI9wbAYRSSquh9NHRaBTxGIdkK3HMvAJNRSL6id+hQFIDMKCRl0bt06JAHfEZRq3kNXS4XgNIoJHHRe3V4YqA8RWsQwqjhHojcBFnhAx9wG0WtFCgwZQN6o1D8Br65ArRXK+3hTjqgOApJZODcYwFIjqJRG1bokrcAPEch2Qx8KVsApqOQfEbvi+KJgfIkpUH0N0B3FE1l6UKA8SgksdF7uXjz4BZWY4MMlCcJjt4nRjUC2I9CchxFgU/igAApJM9RFCjLXAASpJBUB849FYAGKSTZgVs3wIMUku3AJ2ZAhBSS7sB7MWBCCsl39D48KgZAhhRCqQ5fiwA+pBBKdSj9WABOpFCkSIHPzoAWKST7UeA7bAWgRgpJgPSu/POquC6A3AA5UkgKpGB41wT8SCFZkILhvQ1QJIUkQnC/HXAkhWRCcL8dkCSFpEJwvx2wJEWrLCbafQBPUkg2hBIZUJzkQ/AODKiSolVqw0ccYEvYSqkNHXEM0CVMUiL47ihgS5hkRHACmwG2hElGBKewGWBLmKREUIeCAbaESUqkX4PhGMBesuREcDPMAF/CVg1thhlgTJikRQqGTqEMcCZspVSHTaEMcCZsjMxAXQQGSBOmgjNwF4EB1oQVzCI4QJuwQoUAoNMzA7wJk9wIvrHAAG/CJDdCpQXak9wIOjoYoE1YQZJdDLAmrCCdFAZIEyaJEXzbkcGIDUb7KAzGbDCa6WeLqA2lNhQvjNtQvAm+lc1g6IaK3UDtFIPBGyp6g7AnMIBD8iO4PYERHJIfIewJjOGQ/AhuI2AUh6RHCo76PQxwJ4zTSwMGuBOmgjkIGwHYE8YZPewBfcK4ZWXAAIHCuGVlwACDwiRLQskCUChM0iQFxwNgAIfCOBm6xgCFwjgZvsYAg8I4GcLGAIPCSjqKjQEKhZVqyHFUZoBEYZIowVfYDJAorFRjDp2XGWBRmAr24LiaAY3CSqU51LlkgEdhJW0rAY3CJFVCWB9Ao7CSHnSARWGlGnSoe8sAjcLG0A+UVGOAR2GV0h0+GQEihVVkGCIDRAqryEBEBngUVpGhiAzwKEzFgOCdBxApTBEpRFqgtorcImWAR2GKR8HDSxjgUZjiUUqUdGGAR2GSKylK1MdngEhhikgpOWp6AJHCJFdCmGHAozDFo+DRJgzwKEzxKHjACQM8ClM8CgUZRipKa1miBB8DPAqraWsJaBRW09YS0Cispq0lIFFYY7GWgERhikQpcfcWkCissWgOkChMkSilwFEAzVlIFAZIFKZIlCEIBysYKK6xLAsAh8IUhzL4KMgYBRwKkzQJVTBQnaJQ+gUSWjBQnrA4KYBBYSqOpMK9YUChMGFRHuBQmCRKisF5RxADFoUJi/IAjcIUjVKhDDwDNAoTFuUBFoUpFoXoboBFYYpFIboQYFGYYlGIbgFYFKZYFELVgEZhrU19gEZhikYhVAJoFNYq/eFePCBSWGvRH2BSWFtZxAy4FKa4FELMgExhrW30ATaFScqEFDOM9G5tYobB3itazBzwKVzxKRUeIQ0YFS5ZE0J0HFAqfMVp0XHAqXBJnBCi44BV4YpVwUXHAavCJXNCiI4DWoUrWoUSHYgDV7QKHvvHAa3CFa1SieecXVccxKwDXoUrXoWQM+BVuOJVCDkDXoUrXoWQM+BVuOJVCDkDXoUXpUXOgFjh6gwMIWfArHB1DKZq0fMLgFvhkkAp6tXzsrouCggDaFCdhqkLjAfhgF/h6kBMjS43OSBYOKOnQA4IFj6eisGFARgWzugpkAOGhSuGBQ/s44Bh4Yw2oRwwLFwxLBRioD7FsNSoIeeAY+HqmAyBAmhPxadQKID2FMtS43YOHpeRTApVMjwyo2gWPICRw1MzimYhzMDi5Ay3wQD6UzwLMUrg+RnFsxCjBB6hUTwLMUrgKRquxh9+6AWepOG0B8rhWRquFNjiwgAKLC3DD5AtXJEtDW4SAdnCS8vwA2QLV2RLg5tPQLbw0jL8ANfCFdeCx3ZywLXwkvZAOSBbuCJbCBkDtoWPZ2wIuQHtKb6FkgXQnuJbGnS7jQO+hVd0mDMHdAuXnArVPkC48Ipb2gcoF16VlvYB0oVXSn+4XQasC69qG2agQBXAQmEGClTEC4UZKFARLw1uxQHxwhXxQlg5QLxwRbwQDQTEC1cRLEQDAfPCa9sABMwLr232EzAvvLbZT8C88NpmPwHzwlUECx4dyQH3wmuL/QTkC1cxLE2Dsbkc0C+8sdhPQL9wRb80Ai0Y0C/cQr9wQL9wRb80LV4wUJ+FfuGAfuGKfhF4JwL0C7fQLxzQL1zRLwK9C4AD+oVb6BcO6Beu6BfB8IKB8iz0Cwf0C1f0Cx64ywH9wi30Cwf0C1f0C9HdAP3CRWnpQoB/4Yp/IboF4F+4CmMhVA0IGC5s6gMEDFcEDKESQMBwRcAI3OIDAoa3Fv0B/oUr/oUQM+BfuOJfCDED/oW3ttEH+BfelhYxAwKGKwKGEDMgYLgiYAgxAwKGKwJG4JMUIGC4ImAo0cGT3K1NdPAw94oWXQkImFIRMLjoSkDAlIqAwUVXAgKmVAQMLroSEDClImDwWOwSEDDlSMCg83sJCJhSETC4nEtAwJSKgMHlXAICplQEDCVncM5bETCUnIEGFQFDyBkQMKUiYAg5AwKmHAkY1M0oAQFTKgIGdzNKQMCUioDB3YwSEDClImDwcPoSEDBlQU+BJeBfSsW/CJS6KgH/Uhb0FFgC+qVU9ItA3cQS0C+lhX4pAf1SKvqlxTsGoF9KC/1SAvqlVPRLi7qfJaBfSgv9UgL6pRyvJ0HXfyWgX0pmUR5gX0pmUx6gX0pFvxAKAfRLqegXSshAe4p+IQQH6JdS0S8t6sGUgH4puUV9gH0pFftCCAOwL6ViXwhhAPalVOwLIQzAvpSKfaGEARSo2Bf8dEgJ2JeSC1sDgQK5bfjB20xUrAvRQHihieJfiAbCO00kx1K0+B0g8FoTRcAQ09TiZpPSIg14uYliYAhpwPtNytomDaBBRcFQ0gAaVBQMMZnAi04UBUNMJoCCKRUFQ0wmgIIpVcgLfnaoBBxMWVmGIKBgSkXBDAeNEGEACqasLBYUMDClYmCGWJZFOGEJCJiyshhQwL+Uin9p8X4B+Jeyssx+gH4pJcPCVmhARAnol9JyfqgE7EspCRa2wq8JAuxLaQl7KQH5UtY23QHypVTkC64PwL2UinshZAy4l7KuLXID3Esp6RW2wudVwL2UFu6lBNxLqbgXShZAeyr0BZcF4F5Kxb0QsgDcS6m4F0IWgHwpJb/CVvi0CsiXsikt7QPsS9lYxh4gX0p1gIhqH7wdqrG1D6hPsS8rfKYE9EvZWDZvS0C/lOoAESEMwL+Uin/BhQHol1IwizAA/1KqI0SEMAD/UgoL91kC/qUUFu6zBPxLKSzcZwn4l1IoBeKTO+BfSmEZf4B+KYWynuiFDSWgX0oL/VIC+qVUd6ysGkx9gH0pW4vxBORL2SrtobGWJSBfSkvwSwm4l1LSK2yFBguUgHspW8vMB6iXslX3G6JHZ0tAvZStRXeAeSlbm+4A81JJcgXXRwWIl2pV0DKuAPFSrRgttwoQL5XkVhh+D2kFiJdqRWuvArxLtapoWVSAd6nUcSJCFuDaNnX9CiULcHPbSthkAS5vk8wKK/CL3gDtUhUrS/sA7VIV9NirAOtSqUtYiPYB1qUquKV9gHWpJLHC8IOoFWBdqsLCm1WAdakU60IJAyhQHSkihAH0p1gXShhAf0VrEwbQ33gTLDqPVIB3qcawF3QeqQDvUqmDRfg8UgHipWJq/KFzewWIl8pCvFSAeKkkt8KKCpUcIF4qC/FSAeKlGm+HRVdQFSBeKkZbzwrwLpW6I5ZCDNSnDhcV+H2UgHepOL3vXgHapVK0C4EC8C6VujC2QCNIKsC7VOrOWKpkoD51bWyB340JeJdK8S7EWAW8S8UbGwygP25ZtVeAd6m4ZdVeAd6lKi2r9grwLpWkVhhDZ+wK8C6VJe6lArRLJZkVxlAKowK0S2WJe6kA61JJYoUxhhcM9GeJe6kA6VJJXoXh57srQLpUpWX4Ac6lKlubKID2JK1CNQ/eMavCXhhu4+A1sxbOpYIXzVY27cG7ZhXnQkGG180q9aHufQWvnFWsCwUD6K9qbDCA/hTtgt8JXcG7ZyvLyq8CvEuleBcCMyBeKkW8EJgB8VLVll2jCjAvVW3ZNaoA81LVll2jClAvVa00iE8QgHqpassABMxLpZgXhpKvFWBeKgvzUgHmparVAMTdF8C8VJaolwowL5UkVxhHSd0KMC+VJeqlAsRLpYgXjnciQLxUlqiXCvAuleRW2HDN99JFBLxLZQl6qQDtUinahePGE9AulSXopQKsS9W0lk4BWJdKBb0QigasSyVsygO0S6WiXgiFANqlUrQLLmTAulTq0BHHTThgXSpBX3lfAdKlUoeOCMEB0qVSpAslOHhpt7AJDuhPsS6U4ID+FOuCCw6wLpViXfCL4CtAu1SKdiGEAXiXSvEuhDAA71Ip3oUQBiBeKkW8EMIAxEuliBdCGEB/injh+HQGiJdqPHSET2eAeala2/gDzEu9soy/GlAv9coy/mpAvdQry/irAfVSr+jxVwPmpV5ZWM8aUC/1ysJ61oB6qVcW1rMG3EutuBf8KHoNuJdacS8cv+gdcC+14l44etNSDbiXuqAnvxpQL7WiXvAj2zXgXmrFveBHtmvAvdSKe8GPbNeAe6kV90Lc+A+4l1rSK4y69B8oUHEvxL3/gHupFfeCXsldA+6lVtwL8UwA4F7qwuJ81oB7qW3cSw24l9rGvdSAe6lt3EsNuJdacS/E6waAe6nVrS5EAwH5UivyhXjjAJAvtSJfSrzrA/alHg8d4d0ZsC/1yL7g3RnQL7WiXyq8OwP6pR7vdsG7M6Bf6pF+wbsz4F/qMewF786Af6kV/1IRL1kADSr+pcLVDfiXeny2B9cg4F9q9XIP/m5ADfiXWvEv+NMBNeBfasupoxrQL7W6Ihd/aaAG9EutTh3hJwRrQL/Uin6p0csbakC/1Ip+wU/y1YB/qRX/gh+4qwH/Uiv+BT8XVwMCpi5tkyAgYGpFwODn4mrAwNSKgcGPjdWAgakVA4PfmV8DCqZWFAyubcDA1JXNhgIGplZRL4TxAgxMrRgYQtuAgqkVBUNoG1AwtaJgCG0DCqZWFAyhbUDB1OPJI1zbgIKpFQVDaBtQMLWiYAhtAwqmVqEvhLbhE0CW0JcaPgKkGJgGNxrwHSAV+tLghgA+BSRJFtbgZh++BiRJFtbgXQM+CFRbdpDqxZtAcgQ2+BwBnwVSFAz+WEINnwZSFEyDzxHwdSDFweDPGtSAg6kVB9PgcwQgYWpFwuAPENSAhKkVCSNwdQMWplYsjMDVDViYWrEwAlc3oGFqRcMIfJYHPEyteBj8+vkaEDF1Y4nerQERUysiBr+svgZMTN1YbCggYmpFxAj80SpAxNSSa8GvlKoBD1MrHkagcTU14GFqxcMI9F6iGhAxtSJiBPomFuBhasXDDMGcSFqgPUm14O9N1YCGqRUN0xbPeX3djxWQGL7MJZWHXy5fAxqmVjQMHiBdAxqmbi0nN2vAw9SKh2lLdGEAeJha8TD4ZfQ14GFqxcMQ0gA8TK14mBa9K7QGPEyteJgWN0aAh6lbS/RgDYiYWhEx+E55DYiYWkXAoPv1NeBhasXDtLhJBDxMo3iYFp0tG8DDNCs6+qwBNEwjmRb8kcgGsDDNePIITwteWpNEC1+hZrkBLEyjAmBw49IAFqZZ0ffVNYCEaRQJgxuXBpAwjSJhcOPSABKmUSQMalwawME0ioNBjUsDOJhGvUGEP2YHKJhGsiwcf6qgARRMow4d4eUC3RWW9XsDCJimsOkOEDBNYdEd4F+awqY7QMA0hU13gIBpCovuAP/SMIvuAP3SMIvuAPvSqBNHuClsAPvSSIKFr9CJoQHsS8PUyEM9kQawL40kWIaX28vVdVsVIDHQHrPETjSAfWkkwcJXFV4yUJ8kWPiqxhMD9UmChfdGFk0M9KfYF0LOgH1pJMHCV6hJbgD70nBmER1gXxpuObPSAPal4aVFdIB9aXhlER1gXxpJsFCiA+xLwy2+SwPYl4YrDaI+ewPol4a3NtEBDZYW36UB9EszvqOMiw7QL416SpkQHaBfGvWaMiE6QL80in4hRAfol0a9qYy/FtIA+qVRd+wSogP0S6NOHVGiAxoshU10QIPqfWVKdECDkmKhRAf4l0ZFwBCiA/xLo15aLvAZEPAvjXpsmRAd4F+ayjYHAv6lUdftEqID/EtT1RbRAf6lURfuUqIDGlT8CyU6oEFJsXD8EZcG8C9NvbKIDhAwTW1h0BpAwDQ1s4gOEDBNzS2iAwRMU5cW0QECplEhMIToAAHTSI6FF/gMCwiYpm5sogMarC0buQ0gYJq6tYkOaLBZWUQHH2luCovo4DvNjc2TgU81S46F42/2NPC15qa0iA4+2NxYKLQGvtnc1BbRLd5tbmyiAxpshE10QIOKgKFEBzSo3nAu0JV2AxiYRhQW0QEKphGW2+saQME0gltEByiYRpQW0QEOphGVRXSAhGlUMAwhOsDCNOplZ/yJpAawMI0QNtEBDQrLXm4DWJimXVlEB1iYpi0sogMsTNMyi+gAC9PYWJgGsDCNJFo4/mBUA1iYprWtJgAL07S21QRgYZrWtpoALEzT2lYTgIZpWttqAtAwYmVZTQhAwwhJtXD8+SwBeBixsqwmBCBixMqymhCAiREry2pCACZGrCyrCQGYGLGyrCYEoGLEyrKaEICKEZJt4fhjYgJQMWJlWU0IwMWIwrKaEICMEYVlNSEAGyMKy2pCADZGFJbVhAB8jCgsqwkB+BghKReOP60mAB8jCstqQgBCRhSW1YQAhIwoLKsJAQgZUVhWEwIwMoJZVhMCUDKCWVYTAnAygikuFF1NCMDJCGZZTQjAyQhbRIwAnIxgltWEAJyMYJbVhACcjGCW1YQAnIxgltWEAJyMUJwM/u6eAJyM4JbVhACcjOCW1YQAnIzgltWEAJyM4JbVhACcjOCW1YQAnIzgltWEAJyMUJwMQ1cTAnAygltWEwJwMoJbVhMCcDKCW1YTAnAyorSsJgTgZERpWU0IwMmI0rKaEICTEYqTwd8jFICTEaVlNSEAJyNKy2pCAE5GlJbVhACcjCgtqwkBOBlRWlYTAnAyorSsJgTgZITiZBi6mhCAkxGVZTUhACcjKstqQgBORlSW1YQAnIyoLKsJATgZUVlWEwJwMqKyrCYE4GSE4mQYupoQgJMRlWU1IQAnI2zHkgTgZERtWU0IwMmI2rKaEICTEbVlNSEAJyNqy2pCAE5GKE6GoasJATgZUVtWEwJwMqK2rCYE4GREbVlNCMDJiNqymhCAkxG1ZTUhACcjGttqAnAyQnEyDF9NAE5GNLbVBOBkRGNbTQBORjS21QTgZERjW00ATkY0ttUE4GREY1tNAE5GKE6G4asJwMmIxraaAJyMELbVBOBkhLCtJgAnI4RtNQE4GSFsqwnAyQhhW00ATkYoTgZ/zVMATkaoW2HQZ0IFoGSEomTwJyEFoGSEomSGKIXFJqwAjIyQpAvHz60JwMgIW1yMAIyMUHEx+E63AIyMUIwMR48PCMDICEm6cI5PxoCREepSXjSKVABCRihChhAGIGSE5Fw4/tajAISMUIQMfrxFAEJGtLalBCBkhCJk8GcZBSBkWsm5cPwsTAsImVYRMvj5lhYQMu3K4sa0gJBp1fkkPA64BYRMqwiZEr1HpgWETKsIGfzkTAsImVYRMvjJmRYQMq3kXDh+cqYFhEyrCBn85EwLCJlWETL4aZgWEDKtImTQQdUCPqZVfAxuNFrAx7SKj8GPrLSAj2lVdAz6cnIL6JhWMi7E0G4BHdOqu2FQm9gCNqZVbAx+FKYFbExbKPWhEWEtYGNaxcbgR2FawMa0io3Bj8K0gI1pmcWHaQEb00rChePnZlrAxrSKjalQ29UCNqZVbAx+bqYFbExruRumBWRMq8gY/IxNC8iYVpEx+BmbFpAxrSJj8DM2LSBjWhUgg5+xaQEZ0yoyBj9j0wIyprU8Pd0CLqZV8TH4eZwWcDGt4mLwMzYt4GJaxcXUeM8AXEyruJgaN3OAi2lVfEyN9wzAxbSKi6krdGgDLqZVXEyNaxtwMa2Kj6kbvGSgQMXF1Li2ARfTKi6mxrUNuJhWcTENejtMC7iYtrRNgYCLaRUXg5+kaAEX0youBj9J0QIuplXxMfi7QS3gYlrFxeCP8LSAi2kVF4O/ftMCLqZVXAx+OKIFXEyr4mMa9NxMC7iYVnEx+O34LeBiWtv5pBZwMa2Kj2nwSQJwMa3iYigYQIO2+JgWcDHt+Bw13usAF9Oq+BgKBtBgZdmTaAEX0youRuCOF+BiWhUfQ8EAGrS9jNQCLqZVXIxAzxO2gItpFRdDwABcTFtbVvIt4GJaxcXgJ1ZawMW0km4psYjZFjAxrY2JaQET06rjSfhZgxYwMa1iYgTueAEmplVMjMBNOWBiWhsT0wImplVMjMANAWBiWkm2VOhtfy0gYloVHCNwjwAQMa06nURIDhAx7Xg6CQ2PbgER0yoiRuCzDyBiWhsR0wIiplVEjMCnKkDEtJJrGe7bXXY5QMO0NhqmBTRMKyzHW1pAw7QqNGaFWy5Aw7S200ktoGFaFRrT4r4UoGFaRcO0+OQKaJhWUi28RR8uaQEP0yoeBj9G1AIeplU8DP4OQQuImHYkYjDSpgU8TKsiY/D7/1vAw7QqMqbFxx/gYVr1ONJwK+YSBaBhWkXDtPikDWiYtrVNgICHacfjSXifAzxM29I0WgtomFYyLTV6fKcFLEw7voyEYwDKUw8jrXDHAZAw/fBQ6kMtxvjVSG7ZlB+/GsnlFNiiVmP8aiQfFNWvBBGLO340UlvUOH41klsUOX41kitVFshJrPGjkXpQWImfmRq/GsktZ17Gr0ZydeoFPU8zftWTj4eW0ON341cjeSGxoxZq/GokZzI5ugAYvxrJuUyO+irjVyN5KZOja77xq5FcOjcrdI0/fjWS1zI5etp+/GokV1pFZ/Xxq5Fc0NZ7/Gokb2mTPH7Vk0tGplyhZ/jGr0Zy60hlUKtMaZUYqQxqVb2kRIwOBpVqi6EZvxrJrSOVQaVKdqbED2GMX43kct2BX5k4fjWSC1k6uvIYvxrJW5kcXSGMX/XkKp4G94vHr0bywtbDOFSqpGpKPNp9/Gok57RDMX41kqtVCOqmj1+N5HKo4vHj41cjeU37FeNXI7kcqniI9fjVSG7Z1hi/GsmVVlG/ZfyqJ5fUTcWxc8fjRyO1hRofvxrJmW10lFCppW2kllCn6vQTNTGVUKfq/l9qYiqhTtUFNNTEVEKdlkqnhPktoU5LNVIJV6aEOi0tm1XjVz25JHNKPK51/GokL2xmo4JKrZjNbFRQqYrvocxGBbValbZpr4JalbROicehjl+N5JZFy/jVSN7YzEYFtSrJHXLaq6BWK0sk1fhVTy4JnhKPGx2/GsmlVhmhphpq1fI60/jRSK1uCeb4YKqhUiXPU+JXZI9fjeT0daXjRyO1euaHGNg11Kl6Ixu9tmD8aKSWqxn82Zzxq5Hc8tLW+FVP3iiVEm5VA1Xa0Lfmjx+N1Ja7S8evRnJuKxxqVPFC+I2d41cjuU2jDdSourgGv7Rz/GokV3dgoheCjl+N5OoWTOyWz/GjkVpOp/i94+NXPbnl+ezxo5FasezEMBJQo4omKgmhC6hR9Yp2xYjkUKXjO06EGAVUqXrJqSKUJKBOVdROSfRGAXUqOaESv2d9/Gokp2/lGz8aqSXt0FAthTpV4Ts1YQNaqNTxVW1CMC1UqqSHSsrHb6FSW9swbaFOW8sLF+NXI7maTQk/o4U6tTzxNH40UltumBq/GsmV5SWU1EKdKioJf/py/KolL9Qr2/gbnONXI7maTFGiavxqJLdMpgWkkgoV1oNf5j9+NZIr04u3tIBcUiHZopKj3PL41Uhu0WkBuaRifPoJ3XgYvxrJ6YuLxo9GajWZove4jF/15OP7T7h1LCCVVCgqieNebwGppKKwqRQySYUK9MHfCx+/GslVqAHuZxaQSSoKy2xaQCKpkFRRwTnq8xaQSCpUxA8hdMgjFZIpQu/7Gb8ZiQeVEWvNApJIhaSJCIa1gBxSoW7FIToipJAKRSFxnBgsIIVUKAqJo3fujF+N5HImRan18aORWmoTv8Jx/GoklxQSHmw5fjWSS6u7KnGhQwqpUO9yM2wjY/xopFb8PSUXqFH1NPcKjcIbvxrJ1QjFveMCMkgFZ7aWQgapUHflEC2FBFKhnuimWgoJpEI90k22FOqUK53iTmYBCaRCXZlDjH/IHxWSISrxgNvxq5FcOrwcDSEav+rJJUVUEtREAQmkorQsYQrIHxUls2GB/FEhKaISD9MdvxrJ5aoUD9QdvxrJ5USKX0U/fjWSS7OL7oONH43UKsoL7y+QPioUfVTia/sC0keFerybGhmQPioUfYTH945fjeRymJbEMIX0UWF5Tmr8aKRWm92EYCB7VCj2qCQmUsgeFYo9KnGSr4DsUSH5obLEXfUCskdFZRumkDwqFHmEh+WOX43kKvqZcF8geVSoY1x4YOD41UiudEr4u5A8KtQLU/hlz+NXI7kcpxXhkkL2qKjpQNrxo5Fa6hSPKx6/Gslrq2CgTiVBRAsGKlXRR6RgoFIlQVRWxLiG9FGh6CP8zv/xq5FcKhWPXh6/GsmlUgtiUoL8UdEopVLJoVItj0+NH43UlcWYQv6oUKFFeOj8+NVIbrO9kD4qGmEzMZA/KhR/RJkYyB8VQqkU5z0KSCAVwjadQv6oUPwRIUVIHxVCKRTf0iggfVSoSCM85nf8aiSvbGKE9FEhapsYIX1UKPoID2QfvxrJ5TCllkiQPyps1/GMX/Xk6nUqYhesgPxRoQ6AEbxtAfmjQl2NTGyDFZA/Klr6jaPxo5HaRvMWkD8qFH+EHwkYvxrJLeehx69GcqlU/FzA+NVILgcqfjJg/GoklwMVPxswftWSM0kRlfjpgPGrkVzaXvx8wPjVSC4d3xrfImaQQWKSIyrxMwLjVyO5XMwQy1kGGSSmDofhAWvjVyO5sr5YRN740UhtCa0evxrJhWUsMUghsZVSKm7DGKSQWKEizPDtQQYpJFbY4lYYpJCYikbCz1uMX43kauMUZTQYpJCYCkbCz2eMX43k9HuO40cjtU2lkEFiKhQJfxpj/Gokl+MUP9IxfjWSS5XihzrGr3pyZjO+DNJITDJFZUMMa8gjMWZboDLIIzHJFJX4mxrjVyO51Cn+qsb41UgurS9+dGT8aiS37cgwSCQxprRKDCVIJDFFJBF7VQwySUwxScReFYNMElNMEr6JyyCRxNRzV+hN3ONHI7UKWsHu4h4/GqnVAhXffWaQR2JcqZSwAZBHYtwSUT9+NZJLLwl/0mT8aiSXKsUfNRm/GsnlQMWfNRm/GslVeAO+VGKQSGIqEImYkyCPxBSPhO8kMMgjMdt1P+NXI7kcpviTLONXI7nUKX7EZfxqJJfDFH+WZfxqJJc6xd9aGb8ayZVOCSMAmSSmmCT8MMj41UgujS9+aGP8qidXTBJ+EmP8aiRX0b14/AyDTBJTgUj4YplBJolV5MsE4zcj8aA0fBHGIIvEJE9EhE8xSCKxio67Hz8aqaV7hK9NGeSQmGSJ8Kczxo9GajlAKdxQl+P75HhqSCAx9TwWIUHIHzEVfIRzyAzSR0zdz4yeRhg/GqnluhSnJRhkj5i6DYhwdSF5xBR5RFg4yB0xxR0R8obUEZPkEHoWbvxmJJY7a5RyoColM1QRjYS0EZPEUEUoB7JGTPJCNb47xSBpxCQthL9VN340UstRSeGGqpS0UEOIG3JGTLJCDSFBSBkxyQrhx3/Hj0bqQV3E3iSDjBGTnFBDyRvqUlJC+JnX8aORelAXfjR1/GikHtSFnyAdPxqpB3UJQvOQLmKSEBJEKyFbxCQf1FKthLqUdBBxWIFBrohJNqglTBWkipgkg9DzguM3I7HaeCFMFSSKmAo0WhEdHBJFTAUaoYfOxo9GakXn4qHbDPJETFJBRUGoExJFTFJBxGY9gzwRa9V1JVThUJ+t5XwTgzQRU3FGDKcKGaSJmIozIkJ7GKSJWGuJYWCQJeIqzIiIl+eQJeLqSS2OjzgOWSKuLg8iaEsOWSK+skUxcMgS8ZElwocohywRV2+cE5MhhywRVywRzm5wyBJxxRKVeIwEhywRX6nFJz6mOWSJuOSBCmJfj0OWiI+XO+P2hUOWiBcqyBP3QDhkiXihrsMgsEOWiKtII2Iy55Am4urRLfyV4fGrkVwqlZigOeSJuAo1wp+THb8ayZVzSzUValXFGhHzP4dEEVcPoOPvxI5f9eTqCXTCA+CQKOLqEXT8upDxq5Fcbb0QgoREEVcBR/iVIeNXI7nUakMIEhJFXFJBBTFVc0gUcUUUCQo71KqKOBIUdqhVRRQJCjvUqiKKBNEJIFHER6KI0Cpkiri6Bpo4VsYhVcRVyBHhaXDIFXEVckScE+OQK+Iq5ojwTDjkirjiila4c8chV8TVE+krSjJQqyrmaEVJBmpVHVpbUZKBWlVc0YqSDNSqeiu9wP1BDskirsgiYoXOIVvEFVtEHHDikC3i6sV0wlPikC3i6tgafrPi+NVILrVaEJ0AskVcHVsriOEB2SKuXk4vCBsJ2SKu3k4viDkeskVcXRXNKDVBrVaKYSAECdkirp7wIg7PcMgWcRV3RBzk4JAu4irwiGAwOCSMuHpInYji55Ay4uopdSKIk0POiKuLo4lISA5JI64CjwjOg0PWiKsHvTjVVKjV8Ul1YnhA3oiPlxa1z8v6umxLkBwSR1xdW4Tfxzd+NZIzixsJmSNe0xwgh8QRry1RvBwSR1y9rY4TdRwSR1wRR0QYEYfMEVc3SVPOBqSOuLrBiHI2IHnE1R1GlLMB2SOu3vjCLx0bvxrJ1V1wRFMhf8TVndIEocEhgcTHy4wI0w4ZJK7ulSYoDQ4pJN6Q91GN34zEg9YIlodDBolLkohYMHPIIPFGLVLRFTCHDBJvLGtUDhkkrkKOCGaXQwqJC3UUhuiLkEPiQpH0RF+EJBJXQUeUlYYsEhfqYClhuiCNxFXQEWWlIY/EVdARwUtzSCTx8cwa0dMhk8SFissmejrkkrhQcdlET4dcEld3HRFHSjjkknirYu0JrUIyiatDa9SEBMkk3qrAbEKrkEziki+iYso5ZJN4awkO5JBM4ur+acJQQzKJq5gjYpOJQzKJq5gjIhaaQzKJq5gjiniAbFKpYo6IuNkSskmlijkidgVKyCaVKuaI4ClKyCaVKuaI4ClKyCaVI5uEc1UlZJPKle1QTAnZpFKdWiPWbSWkk0pJGOEkbgnJpFKRSTjNWkIuqVRcEkGylSOX9B/Pn222n7r9sbt7s73rPj/70z/+8ezm5vjlsXv2/J/Pbjbqj70ZlMU++9M/n/Xrtz/98/89f9YPRfn/IWZb/ehnLfljiK1SP/j4adg6Uz+a+ceUuJkS97OH+iGmXGJKLKbEYkrcjn8Z+JDxB5t+zJ+a8QcfSx4WZOOPKXE5JS7Hkgd/Xf2op1zNlGsCzyfwfALPJ/B8As8n8IOJkz/Kop5+jInLCXw5gS8n8P1UMv7g06dq/jGlqaY01VTgpItyEng5taIU048ZTzulmYRZtlOB7Zi4Wo2fKjb/qKcfUxo+SqyapFpNUq0mqVbllHhqRVVPnyaE1STnapJzNcm5muRcTXKuxNgN62LMVU9arvv1nPoxSaNuxr+0UyvaqWfKKyWmX9X0qynmX3z+NX8Vc95JpvLA8/RrhCrP106/5r8V89+KqbzhoNT4q5zqLao5XTV/rcvpVzP/EjJH/3Mc2vJfw1Bf3952h8Nx92u3NUZyXZ+Gcj3pqa4qspjjZmeWwDVbwC3ZPq2HrN3j7vajnr/UbImSPZXfMEHDMaA5nzz8Y8t56Lo7PXeh18qUILHMd0au4VL4OddwFTyZa9/L2qhPw6pE3BR81vzUa4ZwD/VrWPRZC7/ZGMi01lSTtVP/F+1U5FT23KmqqcdNI66Y7aqCZK3eaF+/ip4BCFKJU16ZR8stSk083KKMIfv6cXN7vxk+6L1Bn5Hk7Rdjo4VDjr+s79fb2+5+czDK0wfFrBwHsM6QyBBMeUI0hFA6MvftMnpM1WjjajVpiBc+Ba0/b3aHx/V+/XC779bH3d7s+1rJbDZtw3aSu+T3/Xja7b+YSPWxNBu+YQPJo7xHsyhNaGwy6XLryl3UZnvs9j2+ziyx1sU4N7ZwdFJzeA13e2rda+WAA3tToQ//Yu5PpI1VpTyujx8f9937zWezX1VGvyI75X2v+bsv3ecey6Hb780+MLwtexqwK3K0P+yezIFW6H1n8hcmd2HqpNPEzSZ/pp2MXTs5EvKk6TR7zTPf5CPJ1REBaRr+xmgb1pMny8xP02s5F0jqrC9wd2d0muHdqbm0ZvJrmsnTbSa/ppk8i2byvJp6bGgzyWB4IV39mIxrM3nKzSSM4WVh9WNyB0Qxliwm90pM9ltMTuvwWqL6MTmAw0t244+p5Em2grbKj5tl91hxXQBkH3vc/Np9Md0JrrsTI5x68l6Gt4BsRcmcxiQvjEme7Kcy9+N+8DE6AInrHk6rfCu8iIdhdvkAekKjC2JS99TBmnJSdzWpe3LPmsk7ayYL20y+ajMZtmbyuIeHtseeMKl7GjFiGkNiWr4IPql7kq+YRp6YpnQxebHDo3tjT5hKpqfEx8f97lN3c9yvt4elo9cbG00ZLWndl6XcHDYftt3dzeP6y/1ubVhWttL9MHuRBK7hxmDdOJMa3n94Gv6w7O2NZgzb2dPmDdnEfsbZH+X8quyruTZmukNLTqp9GaZl1aU7L5gnQzqpc1rwttNyoT2tL6bFjIzWHdtAu7ZD/cCLLHSXelrATou5qRtOfW5anbPxD6wkBT9URbhteqNX9Tw9C9JaD2WByZlrToOYhlRbnFZHZL8aCjPnEd2Rbe3KW3hste6x8ZOrQVqtqRS7u1ZrMuLF7NkWVs1Svpo+T3I2d5PCLqKlo1aXejknn4+ctqdycC9Nt9GcndpIdqnj7mFze/O03RwPN4/d/ubpcHdrjmndIZhmSrlpRJV47A7H9WJ1q+uUVOTT8WP/781tP/vsu/966kz3b3i+7oRlRYqoL+W4/mDOf7ppK0pS5UMHMgVa6J1mGsvTvMXrmXqauaOJBRIznzOzNxMPM01p9TRL1YzyKsZ1lYlJM/WzZzCN1olDYdVJV5SkxsIf1o+mmPWxW5yKofr2L+tDdzN42SadobkcNekZD3nB+GelvmokR/2Q82G92W5N88/1hUpLToVD7t3j0EvNSafWUU/dvSYdpqEY2PLhNgitz8xk6UQoTLoqJ9eknNzfcnJoqkmvFW+nPsOnPjMRdLPuy+kv83RVzOTbyEkQ0Hvwu/vN2pSfPuAZ2XX2vQNyuwbrM6ZJj63aafKdwbB51UIyXHPBvZdiriaGG2Dn0suJ4inr+cckxWZeR53ISLIfGNUhRqfQmzS5oqvJUDO6Z2gFbw/vu73prWmdtJyopXLyXqtJx9U0nKvixH5StnxRI9IappmzyQ+WR4GIIp8293e39+vNQ2/Sf+0HTLdHLLs+XOnuNhT1n78Bg851g07qaMhqA1DqAJylbLYf0HKGmytPSpnGbTmJqZwWjuVEiJczzTutTeUtlwHVYxrS5rh5Amc15cfJYp+2NunovHBthffb+v6+9zCXtOtwOlEjS0pKxrd9x+uXKEb9rTabNKt5euJUn5Pdbf3LfXeDzH2NZlpnCmRFTZ5zUUhJTF+s1OQSZelrs6bQBUrXPWT8I5jbNPiURseMg3k259NGn08pPY65hz+DflBpddfMmX/7fvPhCelOukNU00oETJBJK5GZNlvY7CFQTJuO5jVlTSpsLOSPSDfmKw18Q1KXsIg/dp97f3S7vr9BymSNvkwltxsWZaqxhpbY6iUKyqCeSnzc3CDMk1ZIQ7Lmp0LgMnp4rP20GhSUH3Aq4OS7AyRcdydJyncuCBmrXPcIW5Jfh0XcLBxbzcC35FJtLgbvj/oahDl7YT+QetsMWVa9z7TkamQuRGoXlKBLpHT2kffrp9u+txHMz/B646k0kuqYSzt0+0/9WlGyUaauhQ6LNqpzQWo+vEFnruGBP60wZxunwvbdb+s92HbQYZGM21zSwvXk+iQm3wpzl4BTbEY55KrPLAc4j6W+AJQPvrgK+fII9tR0N1C+LOEo4ekAIFQGnyzI2WQu4Li5NyHUxoqcdJvmEj6t7zd30LaUOt8h70FylKKsrlmE3hTmnBRoO6dzDO3K1cmmGbZ7v989/Odht0VWo2VlCKmed56dVhQrTN+ulJdZjlNpS3egXliKeH6/2z+sAT+r2/XaYpQfHnuRmyu5le5OTs1i02KHzVvsxewB09vZpKtS6BwknxZQfGL9+cTClMW8/zbH9MxBOdP6a/L5q2llXU8RPPWUpp6oHxn07gFWEd+9awEoCH36L+cyyUXaoieZuzb6nGexFf00tX+6hZypPs75tKDn04Kez2FR04K1nDZyyil0oJoI9moizapq+jR58PXExtZsDpyZyI2JLamn8KpmotqaiXZtpv7STNJqJuammbb0mokTb6YtvWba0mum3dJmWog3016AmBb6ophp+2n3aIIqJoZaTH1ETISMmPZAxNRkMRGGYgqAEhNJIaYGtlN8Uzvtj7aTNNqpOe3E7rWTCtppGLVTFe1UcjvFocmHKMdf8yZHMUe2MHpVsdseeydY7xqtPoTJqKEh476fBzE/t9DDHVwFYN481woQllWFDMTsu3fvHBx3H82QmbI2VraWmf3xC8YX6gvjmvZRhu0Ic0dWX0UWdJyQyolJT3dm2dSbmBj7BWsnunHqTXymhlcTNS0vAfOoF6Mp9I2GuTh6VaaKw/cGSt3Rk7cG2QoZwbx/2i5D6HSnoia3qFU5yold+rBFo29VTKTiGAA1hJ1OcayT9SpJ4mpZESZJ3cSeCB+yI8oyEXJUJ6+m7etynuOmMIpysnrltAHZzME8q3pmBLldB7J61GGpDb9w6nEl7ZmdysN2fLSpcA4RmMM/Gb3ankpFmFedRG7nTdlpnp92ZKopvqiaDH59CrmZo8hYae/wEwJUVLrhKZqTb+fUPEXu6vZw3qmjgzJVeUuPmOk9spr6RDVP6PPG1rRFXE28tXx0bJQRvcrSqsUaoemnOmma5B+WpS1bpHuq1by5TzLFt4dP5n6UblXIaLx+cWJspOgBL1OVYw+e7eVps278MUX9sSl2mU0yYCR1e7eG3rVuTicD1pJu/l33y9OHD/3kaK4WWmPpMQdQ0zC6283D+h5MUnqky7PRz6E65F33fv10b67OKiM6uaHM0pgVdTN09dH7NVMJWPBSo/vQk5ffTjtQ7bSUaicvryWt9113v/5i+h9GTOP/39i1LUeO48ofOg8SSd2+5cSGo9out2vHdYly1XTPRuy/rygpQYBkyv00jo4RqKJIEMhMgBN/vfvp71ySFUaTuwb+hb8ep0sJsChnjQjTiTCiFRfSCr3hJ7Zn3o6PQ5bit3or77zc6es2T8pLrllrtRzFBebq58fnyO7H85EJ040MiCpX3p7n8z8vC4H9vH9avFwD3Y59l+P7+3FRxtfYCh2iUW9zvESG4u3lfXZkcxKXrV3N19EM8Hh5vf9zy2YgeLOD6QQeL28vj5Ode70oR7Zdj5f79fMz/tNL7vs0dkyPyKOlzb0O3ia/89QcKTzPH9fP49dfVqGos9WJf7LNQlU8MGgLzNXBgmBS58iaZXOgP12XTmNq8++MZxrM56OP/T49ylIQzcjS7/77dr1bZzsYNI1y/5EOmZ94e7k9f3yeXl8yr2SE1RQXAqdSpVS0+DVV58gpGaj2J7NKxHIGPx3FufGVbq2WNQaDqeMT2RWlXWoGvxGv6SxBCps8rZ2pjVDTsemp9gnAosRG1a6VtGlywwMKaT1N8Wsm6+o2TfT7Lllmp+1sOWIHt+M51zIHZWmisMf7fKRlx4oWbkjhmEOy4LwsVimEaz1brCspo83rnAAZQY94e8AoA5Q/S9vkPdufp/NpDosPrx/Ht5Ii1Ptg7PgkREuM0DAkOqIffBknBVF+oJOwHntmFjR1KSEyVRy+Hx/W/XmdNo4Q2E4K55IAnJKAi9GNUVoJJXswa8giIGYK0DcFrIOAjD7IRmgpeF8Z0zXNvCduc+5oZ0gnFzLbNDquGK5kXvr0lMIvR0m899Px00rQTbhDT4/3eU/lkrnQmSiYZnvv1/tfBoTUQR7VTa/khYlv9ALB/CF3nSgZFQ3FYz6Hyee1qSF7oNo0XotA/Uu9AHHe0jpl2rdQVhXpsqJ2pIt7eboQzmupG+f00sMvuX5cI1A7T1dLw4IRzTee+fTFQCleD51ht2htxvL4InouZ8/rhGXkq2A2sQX7meZdB7AU0Y2PV+Qa6rMPCHQGEC0D3MiAaq8B2ecAAmCA/x2gfxwE4oMPHIAKjwDRRpA6IwiyESr0EUfYiHhjhOBtRLo4okJ+hNMfsY3GYW/xnq9zKmwnX+ccCMomKfNraB4h5g6Xt1pZg+Y9J8rv/qwK31p9wDm4WidFGyCKPIgin15YivAcTUXSoDWdt15PDjm4wzHmJiiLQep4KYJvaCibRsz2T2MkARTlis8XGye0RtZAAfz48DclSIN5C7YFo6HCfemSOY8QyWMveZzNHsvaC83c0CQJA+WebtSOQtBPinHMZmoSxEkDi1LMBp5mSPAg9Yaz4dfn/T7/Uy7RcJpe6zALHQj1Dq6lQ6jSSVbRUIRuHq4C0vlR77BhZy63h6sKU8OH0RKRZCT/wV4zahOFOxYDAochT7y8XY6PX1l04TSn0tOzuGoxP9xM3TPVa82mNixntlSAfaYQnp6w0UYspptjvditIZtlb2zsfOcsK6vWoWh9BU4oD9jQA7n2wEe9oMgNrSJWI+9qtfXWCdjsAas7eNEjgPeSMumGYqzz2DvhifFMNNaEjdJHNia+oe0HYKAS4jSmyG/vJLMPOg0T96PwaAgKUNY04XybRvGMQnU1QVLbSQ42mtrO77BtqPxVtIpZhBcNQhepNmqa5FUlwaFFI/NwnM7VyAlqiD0UPh4/xsONBwoHZKNEJvuZ9aoweDyVLEVDSyVvpZA3GOC6EQFU0+1879Xa39fPedEd7rFZwWPjMWyEOmkXSTW90eC692phrtN+qKfIejJSEY+0+kUCAs6AkzlAURBQmR1COpx2/LAdsZLj6hghqSCGvaktvrLXWeckVhppP9NIzWrTJaRhx+M9rjV/YWBUWhC6Pl7zFsE8v7MWK2ICjW4AvA5SuIZdFMBkBol1G1oA9JODSAZUa6TUqaGdYqytj8OXxX/0Cp369FlEANPtOBJl+PN0+csa1mUMvWxNQf0aiqJZw9l6MkUt3/3mQtCghR/gj7tGlA3g75EcdG3SMexspedlx0WZXEGK+ppuJ2uo6nedFiJ3UHh0qIfskOR22EedNMVrm52JksGyPaEry1u39/NrsgitIsDH76Bx6ZCydvgGvRQ7Namv2F5ovY5ZSxQ0n9Zh93Wj/AFxKoR+fdL0DDsrch0wO6G1Vr5PysGkHqPVX2LRLm8dfUz8vPh1NJyK1xjdxE/++bGXmvTAa2ZjSjQEJeBmL/JyvlokWqd5MLD+VyjxhMXDbWHOHPSg0o7MUef48Xjcyu45mg1AGeIAZzPgbBwAOA6gRIZelCbAjeCpBwn/RE8LHGEEjjACwxjhKkbkj6O0Q0O8PyKwHvErR+zREYjUiPU/0rZ6dhGaNlEye5DDSluOPmnYhCNh6+t0LulOra53FGxYn6xUDnSGoaWdltb/3RCQajennnUsCDldTtl7O/PezIvF506zI/xPTmHpRIQqNhcGbs7CSqhy1MdVYuFoELVYmj3yUvOQ5aPB6AXFWCv8AwexT5fVy2+sYdmZSyOqFJSwVk4VlkzH4wOF9GFnieMqRvRWpk1ZYGTpwlSyFl4rUycckq2nvA/srdFhhQDUNAht0rJZoXUWXkM3U5cov2/mXIEmlVfTgbr/Zg0sNGdl0rX7pgU5mw1JVyvvovviUGBps3Obk67Kq2jCjsYAmwkTeFVeR7MUVN252ULIWF3Zujsb5XsyQ2s+VHkrPdmUNNyM7QSXsXe/irGl+8/wzQ9d/XPlR+oObFSEZYxU50pXDnNXPYcQN9s/xyS6cGr0t3zF+p1zpsZy+qDqucf+WifVhuomi6SS+NPXPHXn04q6PbLaRx1IiVqmoSHZ6W/r4g21S2HLvAGeri/pJzbheYdIr3uETNJD01HBUDRgIc6sRsU0zBDqBZVq0IR7FEB5aUfbUHxFjZmPpps/ILhxk/wBjBXhjpfmXI1Ado468jhuHdHR9LW0VwQCN4gk1FFVXjRdR4ztD9Qr2SOA9QhgPUI9D8zBpy7S497P0rjcoqTLhtVINYQ1HoyLxzoJyNgC7VeUD5apQvTPA5rqARF56QeO9CwIytlSQDiOuCA09pvpZn0BkrMg/ajAwgYkKgELpJdGdw2V1Gxjrg7fDquRIbDJHdjkDnBxh23QSWkf0oz5p7J4JQ4rqbsdV4cqHbK5DoK1Dqr+DgunS4p1WnsShzM5d1bfagSc+D1AujrwsB1moZfClIZmuWnIbCz987BwOnyyDv6mw7frpQNRMwick9wdRQvjaZv38A6jyYPoGfF5/TlHpjU5UugNrUQFTnOOHqPa49uGzFaiCN10gv6K8yE+a3Mi8wZUvng+/H6put7Qmxo0ekJXygNMX1T+XKkQbg3nTisTCqmEmzQCj9NhEv0dsu0JJ8iEJdo2jfwlatomxSWTMM6pxInqNpf3Kj6hbmiYiCKaC8T43zakb03IIiVkLc0vVxPHxwfnGzTuJ3PhaEi55QK5vkn59s2EKDA2Hyu45fpfKe2F65PiI8HLEUA4aVUKPMVRLHl7vU05OcfSz1tEKKoST92empanEqpOA4H4KQMW0IC67lEuLGkprL4NkMmlzErhj/5+vNyyLacbg2yDi+ZJ1q18Zkw11DuArhw+B9eWXq5FKxpNAdAw4RKT9wi9VGQFXruaiSp4L9fH+/V5qeUiykkONKAW3nwNV7JeOM4od2kZcK3kWYuw4WnQAoGCaLfD/eu4xylouLflwsfZTgS1LA6nma6W5p7bo7uOwmhIkgaWzfHt8PU1f167b3RFeQ9Oo6dc1u14ecuK71rD3UkILPIzcDpOiMa0ytvUbZHKkbYhYyCw1Brk4gqtjudFtrdT1lbG6XZ+PT1Cb/fT+XD/5+14uZ5rVWlaRzoiyhopvEq6leu0c5K2By0F8Oq1LGoi5GqizcczQ/fDL5uBm67adKfNjzF61FRRNlRzcT/+XNL4pZBkAV1fj7c8kA69URFRVOx+LHZoYzRMLpGpCcLm1pZ473D/mS0YHcjQcA/R4pZfrgUJ788MS2713vXYdx5nsoez93hfL/10GlqsjGYDZEhdneoQrTuRlCCd9NiwXi4naigTEoeco+zS7zstZO3pgTnHttfn/OmPvz8Oz696VKAbZ1C15tehvO8nmKo0R4HZ4jlv5NnS56CV2NPRKp5oKwvFTKGaMJO0aYF2dGWdndHbSApFU7jC2DzhmSDSXFmTik0oFRtNFuWD3rTYSn2AaIoxn/Mb3TObOr1fZqP2Izhd4dFTP2K6u73k7LByiBKap2bDf2SylNS0mhLjzU5XMwWf5nR43yN+7mn8zKRiunlFYuyRQ6XWBonyHRLZsf/T18Hq5YjeAKSiH/cU8CrALrP27E0f8qZ/bKywaOCBdMcWZbEKizlIO9qSdzHIPKI2WNgyXKj0dqC3tBjsLi/j1BlPkJjBU/l+bmy/hHMwLXOkhJPeCpNbr5VvaqWTT1eU0SijsGlLN7U82I+yEmktV26uXrapVVN+Sj/8T/ZnRWQZTKYglyV5WrCz3poxR3aP6/XHv4+vVtajz/B+5wh5/Dh8nV6XywWqZnQoQ3HyaOZ4uM+ugNrR2QPV/c92CsJEO0EaLc8PrujZJVObhNFoo6hEfTZw5S9vCs9ZhBJvsJgn4fVj2SrZpS/6V1AB7WIhj0zM++8srk0ty6JtZ+J1erlY3ufaa8JqEiCt4SHSbKAofTWdsKg8Xx6lQY3V+ScXSz9J1WIZ2ZiGIz6dBXtvmslPNH2dYMaGfzB655GuOgKaCTGiA8XCW5xthkU1/RJl0wZl0pPINwTVXtcwX631bJOynXKF0Xpsalv5+aYnO4/mPg9fH9lWMVkXey5vgqTbodDag6UPvY1ujLfmQX58kHV9Nz0shb2irhqmql3ftX+hsN9qIosO9AYPkrd47uY2I/tRgXa7QeI1T0lcWK31tTAJuuDcnkqoYKsWWejFH9IlTPxkgy0bUWitfBDKwfNzdjNTjyQ08RFSFwx+TK7XIiwY5jk/8DqzMkXNHSgmwmFD/V5tSO52b+KTpZpBneB2km9Qkc5erZQODOT+4ylV+Mtly7zyJTdfZ7P0OL1kvbTUKze6KYsuz7M1qz+T9FZJPSZ4mqQbHliTeqMIbZbYKmE0uA7AGC+leq2pZk+kBO1SyltNOJ1/9ZQFswaiiKeYSSPbl4aDSclMVTYRuXuUTaI0V7vzu7LudAYPpWB9GfebFuxQADtkaU4Ofn5QP3+cT1a8ESGSeqDT6iTVY448mDwP7xpA+geqaqiMi2iLDq5b6GCnemxUL9fJA64KtF47frTr81HV3poGlEJNptXa0qjkca02n9BfiN5bEZ8t72zUi4LuaDyaE7P6VGAut1ok5c19MumWeBrPzlZo8wjdTYf2yXtcY++TtRmxTXw0H0eThse18qgupuuxQnuoQQYwoQNo6gEn54CazgFHzABwfICDHYB7DViHgzQkwhAjgO4RQPcIPnYEWDZig46ozR0RQ404MUds6xHQ/DgIhQ7L0KeNoM4nuR15kD9SGakUwghq10je0shx0kpY6dLF0oH5w8f1cfh8eS02gMkcNyupeFUOrO2PSRh/qAmpkLuo0OtMu5DNoAA2jcDYqsWolPJ4ikMvw+QNacxtE9wjxEfrd0oHZyqfpZ+bp4DfYqy4/NuYUYf17ivlGJ/T1GpI+C1tOCBW9sN4HbCFLoXL1JHAbCX2djrkCQkp5F5BjFmOX+uLQpJS01xR7FSjb6cLR4LED54Kxuj9xzoOEaQEwKATFLcR6qSR3dME2UeyZT0Vtui7k/MqUXMflqAGKDGicIQ2aXeKAdAkOaH1AtpQXmhqeo9CrUJ1jNpSvOvFvJTevdKonXs2UqPamruh5fIBCrNrOyWC641gIyWXNAAtzBWxre5l56BRcm3yEn/wPfO5azXb5dq08HaXW1afq+FlVG46nI4u8cGJTUuMiChQPKVvMGRxA7XuHUS5YjxNiClD/DQJT/ju9xeuW4NATlahp5m2aI9z763Tqk7E735/k73/ATvjdLFlSD1B6Y0p2nLNh+tkq5Pz2NMuVsaedeM6rgiJP6HKMW2q7sl1TVsnGnS/7xbeq2yMVuu0qQjWU0lFVkiUb2TNhjog187L4qOw3yMHLPU1OlRd/7xEMuN6j7R5pSubvruShgjPyynecRT/rWpE91Wk+Bm0cVWg25mrUhAuUlpuuw+UwqnmXjU4oJ0X2wVUtaaABrBKpLqkYRVNim7/RmHivEm3zmF7Kj94fmUhrT5/qGstrkLXKveJRnbzmn6hF+TpXvQdf92shY3eYy5lqelOYIHw5LaXNtD+CNE8AZBNjyMJsT2N+qOp5QGjxtD0AnK8nmqDo43Sz+teC2nzU2wHRvZ9vP7unUs+eW+mqH/X91RIZxFP8Qexlfl23YPfJd++N+M7fl3f3OHTD2TBz/OLXoPjjWZeUuY2NeCgxZRbCc/xdXYWcne0hTQ1507VtcpOxYQOkWl5gTJRXuqoY9qBbhdl4ll7D33M0IoCGClrb6x+5ZvfkSWd+sIXl/pzJaghaVgkAgm064mMUcSSOramKzM9fnv+yHW0GqJq6R4RE8Q9mX4LTRJKseUt9qq3U+j7s1Ln8+/WwbUS3RoeWl6L1pymErfc7ekspkuV9NR3Gkv7vk8jrJ2cIZ5qxI3pmgPUdQBd+tVUA2wNWi+ooZ1OWn15Kk01tuquUIdMXepS0bHI4tfBkv9ec3qTHLANbbcRDbxfK540mBzcUWdcubfIuPP1DVxqkiHN8lJuKpXBrad30Gw3T2fCTrWE8VMFh0nXDeAPpAyieaaFH9to8dzKRbwGFkzCaIyRIpld09UbtPX5MiZmlzmezVLd6xgxr/Sj9xT7WI2tF1NV72E16EfaORRWWA2WAmHD36SsmnKMtXZPwRspNc1x1mcL16f7t7g+Jfb7Zsx8DFYZvv9g7jDNFUYpNaa1lMnMN95SR3d98h7scEh2a65S413dKGcyTQCUNesndSLQpVuZqEgtGao7Sb2Euin58P3NXOoziyxeVwI5IM8uTSRVGhRdwHQZD9V5xCZgt9nBLBfzWIJPe/GQnCNdIMWtRNoARc5/nR4fb/fDr5gll9fxGHn6NxY+a3eYmcKqqjv81/8t9Vifp8v8P/3/v/773/8ByudazoIMBQA="; \ No newline at end of file diff --git a/docs/classes/client_api.AddressesApi.html b/docs/classes/client_api.AddressesApi.html index 6d695a8e..7c634ac2 100644 --- a/docs/classes/client_api.AddressesApi.html +++ b/docs/classes/client_api.AddressesApi.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AddressesApi | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.AddressesApi.html">AddressesApi</a></li></ul><h1>Class AddressesApi</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>AddressesApi - object-oriented interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>AddressesApi</p> -</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.AddressesApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">AddressesApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.AddressesApiInterface.html" class="tsd-signature-type tsd-kind-interface">AddressesApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2034">src/client/api.ts:2034</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.AddressesApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.AddressesApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">AddressesApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.AddressesApiInterface.html" class="tsd-signature-type tsd-kind-interface">AddressesApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2034">src/client/api.ts:2034</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.AddressesApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.AddressesApi.html#axios" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a> <a href="client_api.AddressesApi.html#basePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a> <a href="client_api.AddressesApi.html#configuration" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a> @@ -10,42 +10,42 @@ <a href="client_api.AddressesApi.html#listAddressBalances" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Address<wbr/>Balances</span></a> <a href="client_api.AddressesApi.html#listAddresses" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Addresses</span></a> <a href="client_api.AddressesApi.html#requestFaucetFunds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Faucet<wbr/>Funds</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_AddressesApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Addresses<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.AddressesApi.html" class="tsd-signature-type tsd-kind-class">AddressesApi</a><a href="#constructor.new_AddressesApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.AddressesApi.html" class="tsd-signature-type tsd-kind-class">AddressesApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="createAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Address</span><a href="#createAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createAddress.createAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">createAddressRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#createAddress.createAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new address scoped to the wallet.</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_AddressesApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Addresses<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.AddressesApi.html" class="tsd-signature-type tsd-kind-class">AddressesApi</a><a href="#constructor.new_AddressesApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.AddressesApi.html" class="tsd-signature-type tsd-kind-class">AddressesApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="createAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Address</span><a href="#createAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createAddress.createAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">createAddressRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#createAddress.createAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new address scoped to the wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to create the address in.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createAddressRequest</span>: <a href="../interfaces/client_api.CreateAddressRequest.html" class="tsd-signature-type tsd-kind-interface">CreateAddressRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new address</p> <h4>Throws</h4><h4>Memberof</h4><p>AddressesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AddressesApiInterface.html">AddressesApiInterface</a>.<a href="../interfaces/client_api.AddressesApiInterface.html#createAddress">createAddress</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2044">src/client/api.ts:2044</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Address</span><a href="#getAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAddress.getAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getAddress.getAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AddressesApiInterface.html">AddressesApiInterface</a>.<a href="../interfaces/client_api.AddressesApiInterface.html#createAddress">createAddress</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2044">src/client/api.ts:2044</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Address</span><a href="#getAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAddress.getAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getAddress.getAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get address by onchain address</p> <h4>Throws</h4><h4>Memberof</h4><p>AddressesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AddressesApiInterface.html">AddressesApiInterface</a>.<a href="../interfaces/client_api.AddressesApiInterface.html#getAddress">getAddress</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2057">src/client/api.ts:2057</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAddressBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Address<wbr/>Balance</span><a href="#getAddressBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAddressBalance.getAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getAddressBalance.getAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balance</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AddressesApiInterface.html">AddressesApiInterface</a>.<a href="../interfaces/client_api.AddressesApiInterface.html#getAddress">getAddress</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2057">src/client/api.ts:2057</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAddressBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Address<wbr/>Balance</span><a href="#getAddressBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAddressBalance.getAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getAddressBalance.getAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balance</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get address balance for asset</p> <h4>Throws</h4><h4>Memberof</h4><p>AddressesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AddressesApiInterface.html">AddressesApiInterface</a>.<a href="../interfaces/client_api.AddressesApiInterface.html#getAddressBalance">getAddressBalance</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2071">src/client/api.ts:2071</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listAddressBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Address<wbr/>Balances</span><a href="#listAddressBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listAddressBalances.listAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listAddressBalances.listAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balances</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AddressesApiInterface.html">AddressesApiInterface</a>.<a href="../interfaces/client_api.AddressesApiInterface.html#getAddressBalance">getAddressBalance</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2071">src/client/api.ts:2071</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listAddressBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Address<wbr/>Balances</span><a href="#listAddressBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listAddressBalances.listAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listAddressBalances.listAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balances</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balances for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get all balances for address</p> <h4>Throws</h4><h4>Memberof</h4><p>AddressesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AddressesApiInterface.html">AddressesApiInterface</a>.<a href="../interfaces/client_api.AddressesApiInterface.html#listAddressBalances">listAddressBalances</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2085">src/client/api.ts:2085</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listAddresses" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Addresses</span><a href="#listAddresses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listAddresses.listAddresses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Addresses</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listAddresses.listAddresses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List addresses in the wallet.</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AddressesApiInterface.html">AddressesApiInterface</a>.<a href="../interfaces/client_api.AddressesApiInterface.html#listAddressBalances">listAddressBalances</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2085">src/client/api.ts:2085</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listAddresses" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Addresses</span><a href="#listAddresses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listAddresses.listAddresses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Addresses</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listAddresses.listAddresses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List addresses in the wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet whose addresses to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List addresses in a wallet.</p> <h4>Throws</h4><h4>Memberof</h4><p>AddressesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AddressesApiInterface.html">AddressesApiInterface</a>.<a href="../interfaces/client_api.AddressesApiInterface.html#listAddresses">listAddresses</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2099">src/client/api.ts:2099</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="requestFaucetFunds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>Faucet<wbr/>Funds</span><a href="#requestFaucetFunds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="requestFaucetFunds.requestFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#requestFaucetFunds.requestFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to onchain address.</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AddressesApiInterface.html">AddressesApiInterface</a>.<a href="../interfaces/client_api.AddressesApiInterface.html#listAddresses">listAddresses</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2099">src/client/api.ts:2099</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="requestFaucetFunds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>Faucet<wbr/>Funds</span><a href="#requestFaucetFunds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="requestFaucetFunds.requestFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#requestFaucetFunds.requestFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to onchain address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Request faucet funds for onchain address.</p> <h4>Throws</h4><h4>Memberof</h4><p>AddressesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AddressesApiInterface.html">AddressesApiInterface</a>.<a href="../interfaces/client_api.AddressesApiInterface.html#requestFaucetFunds">requestFaucetFunds</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2112">src/client/api.ts:2112</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#createAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Address</span></a><a href="#getAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address</span></a><a href="#getAddressBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address<wbr/>Balance</span></a><a href="#listAddressBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Address<wbr/>Balances</span></a><a href="#listAddresses" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Addresses</span></a><a href="#requestFaucetFunds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Faucet<wbr/>Funds</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AddressesApiInterface.html">AddressesApiInterface</a>.<a href="../interfaces/client_api.AddressesApiInterface.html#requestFaucetFunds">requestFaucetFunds</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2112">src/client/api.ts:2112</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#createAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Address</span></a><a href="#getAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address</span></a><a href="#getAddressBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address<wbr/>Balance</span></a><a href="#listAddressBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Address<wbr/>Balances</span></a><a href="#listAddresses" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Addresses</span></a><a href="#requestFaucetFunds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Faucet<wbr/>Funds</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/client_api.AssetsApi.html b/docs/classes/client_api.AssetsApi.html index c123e922..28a14841 100644 --- a/docs/classes/client_api.AssetsApi.html +++ b/docs/classes/client_api.AssetsApi.html @@ -1,14 +1,14 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AssetsApi | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.AssetsApi.html">AssetsApi</a></li></ul><h1>Class AssetsApi</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>AssetsApi - object-oriented interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>AssetsApi</p> -</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.AssetsApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">AssetsApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.AssetsApiInterface.html" class="tsd-signature-type tsd-kind-interface">AssetsApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2236">src/client/api.ts:2236</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.AssetsApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.AssetsApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">AssetsApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.AssetsApiInterface.html" class="tsd-signature-type tsd-kind-interface">AssetsApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2236">src/client/api.ts:2236</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.AssetsApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.AssetsApi.html#axios" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a> <a href="client_api.AssetsApi.html#basePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a> <a href="client_api.AssetsApi.html#configuration" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.AssetsApi.html#getAsset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_AssetsApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Assets<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.AssetsApi.html" class="tsd-signature-type tsd-kind-class">AssetsApi</a><a href="#constructor.new_AssetsApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.AssetsApi.html" class="tsd-signature-type tsd-kind-class">AssetsApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getAsset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Asset</span><a href="#getAsset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAsset.getAsset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Asset</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getAsset.getAsset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the asset for the specified asset ID.</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_AssetsApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Assets<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.AssetsApi.html" class="tsd-signature-type tsd-kind-class">AssetsApi</a><a href="#constructor.new_AssetsApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.AssetsApi.html" class="tsd-signature-type tsd-kind-class">AssetsApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getAsset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Asset</span><a href="#getAsset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAsset.getAsset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Asset</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getAsset.getAsset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the asset for the specified asset ID.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the asset to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the asset for the specified asset ID.</p> <h4>Throws</h4><h4>Memberof</h4><p>AssetsApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AssetsApiInterface.html">AssetsApiInterface</a>.<a href="../interfaces/client_api.AssetsApiInterface.html#getAsset">getAsset</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2246">src/client/api.ts:2246</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#getAsset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.AssetsApiInterface.html">AssetsApiInterface</a>.<a href="../interfaces/client_api.AssetsApiInterface.html#getAsset">getAsset</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2246">src/client/api.ts:2246</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#getAsset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/client_api.ExternalAddressesApi.html b/docs/classes/client_api.ExternalAddressesApi.html index 28b9bb04..cfb878d0 100644 --- a/docs/classes/client_api.ExternalAddressesApi.html +++ b/docs/classes/client_api.ExternalAddressesApi.html @@ -1,30 +1,30 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ExternalAddressesApi | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ExternalAddressesApi.html">ExternalAddressesApi</a></li></ul><h1>Class ExternalAddressesApi</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ExternalAddressesApi - object-oriented interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ExternalAddressesApi</p> -</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.ExternalAddressesApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">ExternalAddressesApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.ExternalAddressesApiInterface.html" class="tsd-signature-type tsd-kind-interface">ExternalAddressesApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2533">src/client/api.ts:2533</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.ExternalAddressesApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.ExternalAddressesApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">ExternalAddressesApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.ExternalAddressesApiInterface.html" class="tsd-signature-type tsd-kind-interface">ExternalAddressesApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2533">src/client/api.ts:2533</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.ExternalAddressesApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ExternalAddressesApi.html#axios" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a> <a href="client_api.ExternalAddressesApi.html#basePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a> <a href="client_api.ExternalAddressesApi.html#configuration" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.ExternalAddressesApi.html#getExternalAddressBalance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Address<wbr/>Balance</span></a> <a href="client_api.ExternalAddressesApi.html#listExternalAddressBalances" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>External<wbr/>Address<wbr/>Balances</span></a> <a href="client_api.ExternalAddressesApi.html#requestExternalFaucetFunds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>External<wbr/>Faucet<wbr/>Funds</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ExternalAddressesApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>External<wbr/>Addresses<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.ExternalAddressesApi.html" class="tsd-signature-type tsd-kind-class">ExternalAddressesApi</a><a href="#constructor.new_ExternalAddressesApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.ExternalAddressesApi.html" class="tsd-signature-type tsd-kind-class">ExternalAddressesApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getExternalAddressBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>External<wbr/>Address<wbr/>Balance</span><a href="#getExternalAddressBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getExternalAddressBalance.getExternalAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getExternalAddressBalance.getExternalAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the balance of an asset in an external address</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ExternalAddressesApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>External<wbr/>Addresses<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.ExternalAddressesApi.html" class="tsd-signature-type tsd-kind-class">ExternalAddressesApi</a><a href="#constructor.new_ExternalAddressesApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.ExternalAddressesApi.html" class="tsd-signature-type tsd-kind-class">ExternalAddressesApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getExternalAddressBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>External<wbr/>Address<wbr/>Balance</span><a href="#getExternalAddressBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getExternalAddressBalance.getExternalAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getExternalAddressBalance.getExternalAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the balance of an asset in an external address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the asset to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the balance of an asset in an external address</p> <h4>Throws</h4><h4>Memberof</h4><p>ExternalAddressesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ExternalAddressesApiInterface.html">ExternalAddressesApiInterface</a>.<a href="../interfaces/client_api.ExternalAddressesApiInterface.html#getExternalAddressBalance">getExternalAddressBalance</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2544">src/client/api.ts:2544</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listExternalAddressBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>External<wbr/>Address<wbr/>Balances</span><a href="#listExternalAddressBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listExternalAddressBalances.listExternalAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listExternalAddressBalances.listExternalAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List all of the balances of an external address</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ExternalAddressesApiInterface.html">ExternalAddressesApiInterface</a>.<a href="../interfaces/client_api.ExternalAddressesApiInterface.html#getExternalAddressBalance">getExternalAddressBalance</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2544">src/client/api.ts:2544</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listExternalAddressBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>External<wbr/>Address<wbr/>Balances</span><a href="#listExternalAddressBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listExternalAddressBalances.listExternalAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listExternalAddressBalances.listExternalAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List all of the balances of an external address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the balances of an external address</p> <h4>Throws</h4><h4>Memberof</h4><p>ExternalAddressesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ExternalAddressesApiInterface.html">ExternalAddressesApiInterface</a>.<a href="../interfaces/client_api.ExternalAddressesApiInterface.html#listExternalAddressBalances">listExternalAddressBalances</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2558">src/client/api.ts:2558</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="requestExternalFaucetFunds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><a href="#requestExternalFaucetFunds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="requestExternalFaucetFunds.requestExternalFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#requestExternalFaucetFunds.requestExternalFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to external address.</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ExternalAddressesApiInterface.html">ExternalAddressesApiInterface</a>.<a href="../interfaces/client_api.ExternalAddressesApiInterface.html#listExternalAddressBalances">listExternalAddressBalances</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2558">src/client/api.ts:2558</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="requestExternalFaucetFunds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><a href="#requestExternalFaucetFunds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="requestExternalFaucetFunds.requestExternalFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#requestExternalFaucetFunds.requestExternalFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to external address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Request faucet funds for external address.</p> <h4>Throws</h4><h4>Memberof</h4><p>ExternalAddressesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ExternalAddressesApiInterface.html">ExternalAddressesApiInterface</a>.<a href="../interfaces/client_api.ExternalAddressesApiInterface.html#requestExternalFaucetFunds">requestExternalFaucetFunds</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2571">src/client/api.ts:2571</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#getExternalAddressBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Address<wbr/>Balance</span></a><a href="#listExternalAddressBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>External<wbr/>Address<wbr/>Balances</span></a><a href="#requestExternalFaucetFunds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>External<wbr/>Faucet<wbr/>Funds</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ExternalAddressesApiInterface.html">ExternalAddressesApiInterface</a>.<a href="../interfaces/client_api.ExternalAddressesApiInterface.html#requestExternalFaucetFunds">requestExternalFaucetFunds</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2571">src/client/api.ts:2571</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#getExternalAddressBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Address<wbr/>Balance</span></a><a href="#listExternalAddressBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>External<wbr/>Address<wbr/>Balances</span></a><a href="#requestExternalFaucetFunds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>External<wbr/>Faucet<wbr/>Funds</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/client_api.ServerSignersApi.html b/docs/classes/client_api.ServerSignersApi.html index d71e6717..be912de0 100644 --- a/docs/classes/client_api.ServerSignersApi.html +++ b/docs/classes/client_api.ServerSignersApi.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerSignersApi | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ServerSignersApi.html">ServerSignersApi</a></li></ul><h1>Class ServerSignersApi</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ServerSignersApi - object-oriented interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ServerSignersApi</p> -</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.ServerSignersApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">ServerSignersApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.ServerSignersApiInterface.html" class="tsd-signature-type tsd-kind-interface">ServerSignersApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3062">src/client/api.ts:3062</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.ServerSignersApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.ServerSignersApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">ServerSignersApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.ServerSignersApiInterface.html" class="tsd-signature-type tsd-kind-interface">ServerSignersApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3062">src/client/api.ts:3062</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.ServerSignersApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ServerSignersApi.html#axios" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a> <a href="client_api.ServerSignersApi.html#basePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a> <a href="client_api.ServerSignersApi.html#configuration" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a> @@ -10,36 +10,36 @@ <a href="client_api.ServerSignersApi.html#listServerSigners" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Server<wbr/>Signers</span></a> <a href="client_api.ServerSignersApi.html#submitServerSignerSeedEventResult" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span></a> <a href="client_api.ServerSignersApi.html#submitServerSignerSignatureEventResult" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ServerSignersApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Server<wbr/>Signers<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.ServerSignersApi.html" class="tsd-signature-type tsd-kind-class">ServerSignersApi</a><a href="#constructor.new_ServerSignersApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.ServerSignersApi.html" class="tsd-signature-type tsd-kind-class">ServerSignersApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="createServerSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Server<wbr/>Signer</span><a href="#createServerSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createServerSigner.createServerSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createServerSignerRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#createServerSigner.createServerSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new Server-Signer</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ServerSignersApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Server<wbr/>Signers<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.ServerSignersApi.html" class="tsd-signature-type tsd-kind-class">ServerSignersApi</a><a href="#constructor.new_ServerSignersApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.ServerSignersApi.html" class="tsd-signature-type tsd-kind-class">ServerSignersApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="createServerSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Server<wbr/>Signer</span><a href="#createServerSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createServerSigner.createServerSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createServerSignerRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#createServerSigner.createServerSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new Server-Signer</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createServerSignerRequest</span>: <a href="../interfaces/client_api.CreateServerSignerRequest.html" class="tsd-signature-type tsd-kind-interface">CreateServerSignerRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new Server-Signer</p> <h4>Throws</h4><h4>Memberof</h4><p>ServerSignersApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a>.<a href="../interfaces/client_api.ServerSignersApiInterface.html#createServerSigner">createServerSigner</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3071">src/client/api.ts:3071</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getServerSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Server<wbr/>Signer</span><a href="#getServerSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getServerSigner.getServerSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getServerSigner.getServerSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a server signer by ID</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a>.<a href="../interfaces/client_api.ServerSignersApiInterface.html#createServerSigner">createServerSigner</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3071">src/client/api.ts:3071</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getServerSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Server<wbr/>Signer</span><a href="#getServerSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getServerSigner.getServerSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getServerSigner.getServerSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a server signer by ID</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a server signer by ID</p> <h4>Throws</h4><h4>Memberof</h4><p>ServerSignersApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a>.<a href="../interfaces/client_api.ServerSignersApiInterface.html#getServerSigner">getServerSigner</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3083">src/client/api.ts:3083</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listServerSignerEvents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Server<wbr/>Signer<wbr/>Events</span><a href="#listServerSignerEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listServerSignerEvents.listServerSignerEvents-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signer<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listServerSignerEvents.listServerSignerEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List events for a server signer</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a>.<a href="../interfaces/client_api.ServerSignersApiInterface.html#getServerSigner">getServerSigner</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3083">src/client/api.ts:3083</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listServerSignerEvents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Server<wbr/>Signer<wbr/>Events</span><a href="#listServerSignerEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listServerSignerEvents.listServerSignerEvents-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signer<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listServerSignerEvents.listServerSignerEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List events for a server signer</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to fetch events for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List events for a server signer</p> <h4>Throws</h4><h4>Memberof</h4><p>ServerSignersApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a>.<a href="../interfaces/client_api.ServerSignersApiInterface.html#listServerSignerEvents">listServerSignerEvents</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3097">src/client/api.ts:3097</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listServerSigners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Server<wbr/>Signers</span><a href="#listServerSigners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listServerSigners.listServerSigners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listServerSigners.listServerSigners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List server signers for the current project</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a>.<a href="../interfaces/client_api.ServerSignersApiInterface.html#listServerSignerEvents">listServerSignerEvents</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3097">src/client/api.ts:3097</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listServerSigners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Server<wbr/>Signers</span><a href="#listServerSigners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listServerSigners.listServerSigners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listServerSigners.listServerSigners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List server signers for the current project</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List server signers for the current project</p> <h4>Throws</h4><h4>Memberof</h4><p>ServerSignersApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a>.<a href="../interfaces/client_api.ServerSignersApiInterface.html#listServerSigners">listServerSigners</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3110">src/client/api.ts:3110</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="submitServerSignerSeedEventResult" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><a href="#submitServerSignerSeedEventResult" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">seedCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a>.<a href="../interfaces/client_api.ServerSignersApiInterface.html#listServerSigners">listServerSigners</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3110">src/client/api.ts:3110</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="submitServerSignerSeedEventResult" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><a href="#submitServerSignerSeedEventResult" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">seedCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to submit the event result for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">seedCreationEventResult</span>: <a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Submit the result of a server signer event</p> <h4>Throws</h4><h4>Memberof</h4><p>ServerSignersApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a>.<a href="../interfaces/client_api.ServerSignersApiInterface.html#submitServerSignerSeedEventResult">submitServerSignerSeedEventResult</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3123">src/client/api.ts:3123</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="submitServerSignerSignatureEventResult" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><a href="#submitServerSignerSignatureEventResult" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a>.<a href="../interfaces/client_api.ServerSignersApiInterface.html#submitServerSignerSeedEventResult">submitServerSignerSeedEventResult</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3123">src/client/api.ts:3123</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="submitServerSignerSignatureEventResult" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><a href="#submitServerSignerSignatureEventResult" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to submit the event result for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">signatureCreationEventResult</span>: <a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Submit the result of a server signer event</p> <h4>Throws</h4><h4>Memberof</h4><p>ServerSignersApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a>.<a href="../interfaces/client_api.ServerSignersApiInterface.html#submitServerSignerSignatureEventResult">submitServerSignerSignatureEventResult</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3136">src/client/api.ts:3136</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#createServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Server<wbr/>Signer</span></a><a href="#getServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Server<wbr/>Signer</span></a><a href="#listServerSignerEvents" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Server<wbr/>Signer<wbr/>Events</span></a><a href="#listServerSigners" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Server<wbr/>Signers</span></a><a href="#submitServerSignerSeedEventResult" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span></a><a href="#submitServerSignerSignatureEventResult" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a>.<a href="../interfaces/client_api.ServerSignersApiInterface.html#submitServerSignerSignatureEventResult">submitServerSignerSignatureEventResult</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3136">src/client/api.ts:3136</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#createServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Server<wbr/>Signer</span></a><a href="#getServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Server<wbr/>Signer</span></a><a href="#listServerSignerEvents" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Server<wbr/>Signer<wbr/>Events</span></a><a href="#listServerSigners" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Server<wbr/>Signers</span></a><a href="#submitServerSignerSeedEventResult" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span></a><a href="#submitServerSignerSignatureEventResult" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/client_api.StakeApi.html b/docs/classes/client_api.StakeApi.html index 9089583d..e90d2edf 100644 --- a/docs/classes/client_api.StakeApi.html +++ b/docs/classes/client_api.StakeApi.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakeApi | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakeApi.html">StakeApi</a></li></ul><h1>Class StakeApi</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>StakeApi - object-oriented interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>StakeApi</p> -</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.StakeApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">StakeApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.StakeApiInterface.html" class="tsd-signature-type tsd-kind-interface">StakeApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3490">src/client/api.ts:3490</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.StakeApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.StakeApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">StakeApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.StakeApiInterface.html" class="tsd-signature-type tsd-kind-interface">StakeApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3490">src/client/api.ts:3490</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.StakeApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.StakeApi.html#axios" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a> <a href="client_api.StakeApi.html#basePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a> <a href="client_api.StakeApi.html#configuration" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a> @@ -8,25 +8,25 @@ <a href="client_api.StakeApi.html#fetchStakingRewards" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Staking<wbr/>Rewards</span></a> <a href="client_api.StakeApi.html#getExternalStakingOperation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Staking<wbr/>Operation</span></a> <a href="client_api.StakeApi.html#getStakingContext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Staking<wbr/>Context</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_StakeApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Stake<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.StakeApi.html" class="tsd-signature-type tsd-kind-class">StakeApi</a><a href="#constructor.new_StakeApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.StakeApi.html" class="tsd-signature-type tsd-kind-class">StakeApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="buildStakingOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build<wbr/>Staking<wbr/>Operation</span><a href="#buildStakingOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="buildStakingOperation.buildStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#buildStakingOperation.buildStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Build a new staking operation</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_StakeApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Stake<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.StakeApi.html" class="tsd-signature-type tsd-kind-class">StakeApi</a><a href="#constructor.new_StakeApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.StakeApi.html" class="tsd-signature-type tsd-kind-class">StakeApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="buildStakingOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build<wbr/>Staking<wbr/>Operation</span><a href="#buildStakingOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="buildStakingOperation.buildStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#buildStakingOperation.buildStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Build a new staking operation</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>: <a href="../interfaces/client_api.BuildStakingOperationRequest.html" class="tsd-signature-type tsd-kind-interface">BuildStakingOperationRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Build a new staking operation</p> <h4>Throws</h4><h4>Memberof</h4><p>StakeApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.StakeApiInterface.html">StakeApiInterface</a>.<a href="../interfaces/client_api.StakeApiInterface.html#buildStakingOperation">buildStakingOperation</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3499">src/client/api.ts:3499</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fetchStakingRewards" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fetch<wbr/>Staking<wbr/>Rewards</span><a href="#fetchStakingRewards" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetchStakingRewards.fetchStakingRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#fetchStakingRewards.fetchStakingRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetch staking rewards for a list of addresses</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.StakeApiInterface.html">StakeApiInterface</a>.<a href="../interfaces/client_api.StakeApiInterface.html#buildStakingOperation">buildStakingOperation</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3499">src/client/api.ts:3499</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fetchStakingRewards" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fetch<wbr/>Staking<wbr/>Rewards</span><a href="#fetchStakingRewards" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetchStakingRewards.fetchStakingRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#fetchStakingRewards.fetchStakingRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetch staking rewards for a list of addresses</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>: <a href="../interfaces/client_api.FetchStakingRewardsRequest.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewardsRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Fetch staking rewards</p> <h4>Throws</h4><h4>Memberof</h4><p>StakeApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.StakeApiInterface.html">StakeApiInterface</a>.<a href="../interfaces/client_api.StakeApiInterface.html#fetchStakingRewards">fetchStakingRewards</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3513">src/client/api.ts:3513</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getExternalStakingOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>External<wbr/>Staking<wbr/>Operation</span><a href="#getExternalStakingOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getExternalStakingOperation.getExternalStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getExternalStakingOperation.getExternalStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the latest state of a staking operation</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.StakeApiInterface.html">StakeApiInterface</a>.<a href="../interfaces/client_api.StakeApiInterface.html#fetchStakingRewards">fetchStakingRewards</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3513">src/client/api.ts:3513</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getExternalStakingOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>External<wbr/>Staking<wbr/>Operation</span><a href="#getExternalStakingOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getExternalStakingOperation.getExternalStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getExternalStakingOperation.getExternalStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the latest state of a staking operation</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to fetch the staking operation for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">stakingOperationId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the staking operation</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the latest state of a staking operation</p> <h4>Throws</h4><h4>Memberof</h4><p>StakeApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.StakeApiInterface.html">StakeApiInterface</a>.<a href="../interfaces/client_api.StakeApiInterface.html#getExternalStakingOperation">getExternalStakingOperation</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3527">src/client/api.ts:3527</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStakingContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Staking<wbr/>Context</span><a href="#getStakingContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStakingContext.getStakingContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getStakingContext.getStakingContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get staking context for an address</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.StakeApiInterface.html">StakeApiInterface</a>.<a href="../interfaces/client_api.StakeApiInterface.html#getExternalStakingOperation">getExternalStakingOperation</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3527">src/client/api.ts:3527</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStakingContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Staking<wbr/>Context</span><a href="#getStakingContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStakingContext.getStakingContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getStakingContext.getStakingContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get staking context for an address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">getStakingContextRequest</span>: <a href="../interfaces/client_api.GetStakingContextRequest.html" class="tsd-signature-type tsd-kind-interface">GetStakingContextRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get staking context</p> <h4>Throws</h4><h4>Memberof</h4><p>StakeApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.StakeApiInterface.html">StakeApiInterface</a>.<a href="../interfaces/client_api.StakeApiInterface.html#getStakingContext">getStakingContext</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3539">src/client/api.ts:3539</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#buildStakingOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Staking<wbr/>Operation</span></a><a href="#fetchStakingRewards" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Staking<wbr/>Rewards</span></a><a href="#getExternalStakingOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Staking<wbr/>Operation</span></a><a href="#getStakingContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Staking<wbr/>Context</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.StakeApiInterface.html">StakeApiInterface</a>.<a href="../interfaces/client_api.StakeApiInterface.html#getStakingContext">getStakingContext</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3539">src/client/api.ts:3539</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#buildStakingOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Staking<wbr/>Operation</span></a><a href="#fetchStakingRewards" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Staking<wbr/>Rewards</span></a><a href="#getExternalStakingOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Staking<wbr/>Operation</span></a><a href="#getStakingContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Staking<wbr/>Context</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/client_api.TradesApi.html b/docs/classes/client_api.TradesApi.html index 8a238e9d..17ea8843 100644 --- a/docs/classes/client_api.TradesApi.html +++ b/docs/classes/client_api.TradesApi.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TradesApi | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TradesApi.html">TradesApi</a></li></ul><h1>Class TradesApi</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>TradesApi - object-oriented interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>TradesApi</p> -</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.TradesApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">TradesApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.TradesApiInterface.html" class="tsd-signature-type tsd-kind-interface">TradesApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3933">src/client/api.ts:3933</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.TradesApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.TradesApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">TradesApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.TradesApiInterface.html" class="tsd-signature-type tsd-kind-interface">TradesApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3933">src/client/api.ts:3933</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.TradesApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.TradesApi.html#axios" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a> <a href="client_api.TradesApi.html#basePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a> <a href="client_api.TradesApi.html#configuration" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a> @@ -8,27 +8,27 @@ <a href="client_api.TradesApi.html#createTrade" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Trade</span></a> <a href="client_api.TradesApi.html#getTrade" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trade</span></a> <a href="client_api.TradesApi.html#listTrades" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Trades</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_TradesApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Trades<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.TradesApi.html" class="tsd-signature-type tsd-kind-class">TradesApi</a><a href="#constructor.new_TradesApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.TradesApi.html" class="tsd-signature-type tsd-kind-class">TradesApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="broadcastTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>broadcast<wbr/>Trade</span><a href="#broadcastTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="broadcastTrade.broadcastTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">broadcast<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">broadcastTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#broadcastTrade.broadcastTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Broadcast a trade</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_TradesApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Trades<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.TradesApi.html" class="tsd-signature-type tsd-kind-class">TradesApi</a><a href="#constructor.new_TradesApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.TradesApi.html" class="tsd-signature-type tsd-kind-class">TradesApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="broadcastTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>broadcast<wbr/>Trade</span><a href="#broadcastTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="broadcastTrade.broadcastTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">broadcast<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">broadcastTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#broadcastTrade.broadcastTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Broadcast a trade</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the trade belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">tradeId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the trade to broadcast</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">broadcastTradeRequest</span>: <a href="../interfaces/client_api.BroadcastTradeRequest.html" class="tsd-signature-type tsd-kind-interface">BroadcastTradeRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Broadcast a trade</p> <h4>Throws</h4><h4>Memberof</h4><p>TradesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TradesApiInterface.html">TradesApiInterface</a>.<a href="../interfaces/client_api.TradesApiInterface.html#broadcastTrade">broadcastTrade</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3945">src/client/api.ts:3945</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Trade</span><a href="#createTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new trade</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TradesApiInterface.html">TradesApiInterface</a>.<a href="../interfaces/client_api.TradesApiInterface.html#broadcastTrade">broadcastTrade</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3945">src/client/api.ts:3945</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Trade</span><a href="#createTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new trade</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the source address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to conduct the trade from</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">createTradeRequest</span>: <a href="../interfaces/client_api.CreateTradeRequest.html" class="tsd-signature-type tsd-kind-interface">CreateTradeRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new trade for an address</p> <h4>Throws</h4><h4>Memberof</h4><p>TradesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TradesApiInterface.html">TradesApiInterface</a>.<a href="../interfaces/client_api.TradesApiInterface.html#createTrade">createTrade</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3959">src/client/api.ts:3959</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Trade</span><a href="#getTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTrade.getTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getTrade.getTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a trade by ID</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TradesApiInterface.html">TradesApiInterface</a>.<a href="../interfaces/client_api.TradesApiInterface.html#createTrade">createTrade</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3959">src/client/api.ts:3959</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Trade</span><a href="#getTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTrade.getTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getTrade.getTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a trade by ID</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the trade belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">tradeId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the trade to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a trade by ID</p> <h4>Throws</h4><h4>Memberof</h4><p>TradesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TradesApiInterface.html">TradesApiInterface</a>.<a href="../interfaces/client_api.TradesApiInterface.html#getTrade">getTrade</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3973">src/client/api.ts:3973</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTrades" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Trades</span><a href="#listTrades" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTrades.listTrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Trades</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listTrades.listTrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List trades for an address.</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TradesApiInterface.html">TradesApiInterface</a>.<a href="../interfaces/client_api.TradesApiInterface.html#getTrade">getTrade</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3973">src/client/api.ts:3973</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTrades" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Trades</span><a href="#listTrades" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTrades.listTrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Trades</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listTrades.listTrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List trades for an address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to list trades for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> @@ -36,4 +36,4 @@ <h4>Throws</h4><h4>Memberof</h4><p>TradesApi</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List trades for an address.</p> <h4>Throws</h4><h4>Memberof</h4><p>TradesApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TradesApiInterface.html">TradesApiInterface</a>.<a href="../interfaces/client_api.TradesApiInterface.html#listTrades">listTrades</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3988">src/client/api.ts:3988</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#broadcastTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Trade</span></a><a href="#createTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Trade</span></a><a href="#getTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trade</span></a><a href="#listTrades" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Trades</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TradesApiInterface.html">TradesApiInterface</a>.<a href="../interfaces/client_api.TradesApiInterface.html#listTrades">listTrades</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3988">src/client/api.ts:3988</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#broadcastTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Trade</span></a><a href="#createTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Trade</span></a><a href="#getTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trade</span></a><a href="#listTrades" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Trades</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/client_api.TransfersApi.html b/docs/classes/client_api.TransfersApi.html index fb8740a4..bdf732f8 100644 --- a/docs/classes/client_api.TransfersApi.html +++ b/docs/classes/client_api.TransfersApi.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransfersApi | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransfersApi.html">TransfersApi</a></li></ul><h1>Class TransfersApi</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>TransfersApi - object-oriented interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>TransfersApi</p> -</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.TransfersApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">TransfersApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.TransfersApiInterface.html" class="tsd-signature-type tsd-kind-interface">TransfersApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4382">src/client/api.ts:4382</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.TransfersApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.TransfersApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">TransfersApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.TransfersApiInterface.html" class="tsd-signature-type tsd-kind-interface">TransfersApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4382">src/client/api.ts:4382</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.TransfersApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.TransfersApi.html#axios" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a> <a href="client_api.TransfersApi.html#basePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a> <a href="client_api.TransfersApi.html#configuration" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a> @@ -8,27 +8,27 @@ <a href="client_api.TransfersApi.html#createTransfer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Transfer</span></a> <a href="client_api.TransfersApi.html#getTransfer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transfer</span></a> <a href="client_api.TransfersApi.html#listTransfers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Transfers</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_TransfersApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Transfers<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.TransfersApi.html" class="tsd-signature-type tsd-kind-class">TransfersApi</a><a href="#constructor.new_TransfersApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.TransfersApi.html" class="tsd-signature-type tsd-kind-class">TransfersApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="broadcastTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>broadcast<wbr/>Transfer</span><a href="#broadcastTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="broadcastTransfer.broadcastTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">broadcast<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">broadcastTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#broadcastTransfer.broadcastTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Broadcast a transfer</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_TransfersApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Transfers<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.TransfersApi.html" class="tsd-signature-type tsd-kind-class">TransfersApi</a><a href="#constructor.new_TransfersApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.TransfersApi.html" class="tsd-signature-type tsd-kind-class">TransfersApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="broadcastTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>broadcast<wbr/>Transfer</span><a href="#broadcastTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="broadcastTransfer.broadcastTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">broadcast<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">broadcastTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#broadcastTransfer.broadcastTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Broadcast a transfer</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the transfer belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">transferId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the transfer to broadcast</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">broadcastTransferRequest</span>: <a href="../interfaces/client_api.BroadcastTransferRequest.html" class="tsd-signature-type tsd-kind-interface">BroadcastTransferRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Broadcast a transfer</p> <h4>Throws</h4><h4>Memberof</h4><p>TransfersApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TransfersApiInterface.html">TransfersApiInterface</a>.<a href="../interfaces/client_api.TransfersApiInterface.html#broadcastTransfer">broadcastTransfer</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4394">src/client/api.ts:4394</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Transfer</span><a href="#createTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new transfer</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TransfersApiInterface.html">TransfersApiInterface</a>.<a href="../interfaces/client_api.TransfersApiInterface.html#broadcastTransfer">broadcastTransfer</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4394">src/client/api.ts:4394</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Transfer</span><a href="#createTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new transfer</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the source address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to transfer from</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">createTransferRequest</span>: <a href="../interfaces/client_api.CreateTransferRequest.html" class="tsd-signature-type tsd-kind-interface">CreateTransferRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new transfer for an address</p> <h4>Throws</h4><h4>Memberof</h4><p>TransfersApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TransfersApiInterface.html">TransfersApiInterface</a>.<a href="../interfaces/client_api.TransfersApiInterface.html#createTransfer">createTransfer</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4408">src/client/api.ts:4408</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transfer</span><a href="#getTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransfer.getTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getTransfer.getTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a transfer by ID</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TransfersApiInterface.html">TransfersApiInterface</a>.<a href="../interfaces/client_api.TransfersApiInterface.html#createTransfer">createTransfer</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4408">src/client/api.ts:4408</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transfer</span><a href="#getTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransfer.getTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getTransfer.getTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a transfer by ID</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the transfer belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">transferId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the transfer to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a transfer by ID</p> <h4>Throws</h4><h4>Memberof</h4><p>TransfersApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TransfersApiInterface.html">TransfersApiInterface</a>.<a href="../interfaces/client_api.TransfersApiInterface.html#getTransfer">getTransfer</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4422">src/client/api.ts:4422</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTransfers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Transfers</span><a href="#listTransfers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTransfers.listTransfers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Transfers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listTransfers.listTransfers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List transfers for an address.</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TransfersApiInterface.html">TransfersApiInterface</a>.<a href="../interfaces/client_api.TransfersApiInterface.html#getTransfer">getTransfer</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4422">src/client/api.ts:4422</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTransfers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Transfers</span><a href="#listTransfers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTransfers.listTransfers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Transfers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listTransfers.listTransfers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List transfers for an address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to list transfers for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> @@ -36,4 +36,4 @@ <h4>Throws</h4><h4>Memberof</h4><p>TransfersApi</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List transfers for an address.</p> <h4>Throws</h4><h4>Memberof</h4><p>TransfersApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TransfersApiInterface.html">TransfersApiInterface</a>.<a href="../interfaces/client_api.TransfersApiInterface.html#listTransfers">listTransfers</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4437">src/client/api.ts:4437</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#broadcastTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Transfer</span></a><a href="#createTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Transfer</span></a><a href="#getTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transfer</span></a><a href="#listTransfers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Transfers</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.TransfersApiInterface.html">TransfersApiInterface</a>.<a href="../interfaces/client_api.TransfersApiInterface.html#listTransfers">listTransfers</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4437">src/client/api.ts:4437</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#broadcastTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Transfer</span></a><a href="#createTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Transfer</span></a><a href="#getTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transfer</span></a><a href="#listTransfers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Transfers</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/client_api.UsersApi.html b/docs/classes/client_api.UsersApi.html index aecb1ed0..e2c80e1f 100644 --- a/docs/classes/client_api.UsersApi.html +++ b/docs/classes/client_api.UsersApi.html @@ -1,12 +1,12 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UsersApi | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.UsersApi.html">UsersApi</a></li></ul><h1>Class UsersApi</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>UsersApi - object-oriented interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>UsersApi</p> -</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.UsersApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">UsersApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.UsersApiInterface.html" class="tsd-signature-type tsd-kind-interface">UsersApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4547">src/client/api.ts:4547</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.UsersApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.UsersApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">UsersApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.UsersApiInterface.html" class="tsd-signature-type tsd-kind-interface">UsersApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4547">src/client/api.ts:4547</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.UsersApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.UsersApi.html#axios" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a> <a href="client_api.UsersApi.html#basePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a> <a href="client_api.UsersApi.html#configuration" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.UsersApi.html#getCurrentUser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>User</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_UsersApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Users<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.UsersApi.html" class="tsd-signature-type tsd-kind-class">UsersApi</a><a href="#constructor.new_UsersApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.UsersApi.html" class="tsd-signature-type tsd-kind-class">UsersApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getCurrentUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Current<wbr/>User</span><a href="#getCurrentUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getCurrentUser.getCurrentUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Current<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getCurrentUser.getCurrentUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get current user</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_UsersApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Users<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.UsersApi.html" class="tsd-signature-type tsd-kind-class">UsersApi</a><a href="#constructor.new_UsersApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.UsersApi.html" class="tsd-signature-type tsd-kind-class">UsersApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getCurrentUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Current<wbr/>User</span><a href="#getCurrentUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getCurrentUser.getCurrentUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Current<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getCurrentUser.getCurrentUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get current user</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get current user</p> <h4>Throws</h4><h4>Memberof</h4><p>UsersApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.UsersApiInterface.html">UsersApiInterface</a>.<a href="../interfaces/client_api.UsersApiInterface.html#getCurrentUser">getCurrentUser</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4555">src/client/api.ts:4555</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#getCurrentUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>User</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.UsersApiInterface.html">UsersApiInterface</a>.<a href="../interfaces/client_api.UsersApiInterface.html#getCurrentUser">getCurrentUser</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4555">src/client/api.ts:4555</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#getCurrentUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>User</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/client_api.ValidatorsApi.html b/docs/classes/client_api.ValidatorsApi.html index f816cb37..bcc3c36b 100644 --- a/docs/classes/client_api.ValidatorsApi.html +++ b/docs/classes/client_api.ValidatorsApi.html @@ -1,19 +1,19 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ValidatorsApi | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ValidatorsApi.html">ValidatorsApi</a></li></ul><h1>Class ValidatorsApi</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ValidatorsApi - object-oriented interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ValidatorsApi</p> -</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.ValidatorsApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">ValidatorsApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.ValidatorsApiInterface.html" class="tsd-signature-type tsd-kind-interface">ValidatorsApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4784">src/client/api.ts:4784</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.ValidatorsApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.ValidatorsApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">ValidatorsApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.ValidatorsApiInterface.html" class="tsd-signature-type tsd-kind-interface">ValidatorsApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4784">src/client/api.ts:4784</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.ValidatorsApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ValidatorsApi.html#axios" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a> <a href="client_api.ValidatorsApi.html#basePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a> <a href="client_api.ValidatorsApi.html#configuration" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.ValidatorsApi.html#getValidator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Validator</span></a> <a href="client_api.ValidatorsApi.html#listValidators" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Validators</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ValidatorsApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Validators<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.ValidatorsApi.html" class="tsd-signature-type tsd-kind-class">ValidatorsApi</a><a href="#constructor.new_ValidatorsApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.ValidatorsApi.html" class="tsd-signature-type tsd-kind-class">ValidatorsApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getValidator" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Validator</span><a href="#getValidator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getValidator.getValidator-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Validator</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">validatorId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getValidator.getValidator-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a validator belonging to the user for a given network, asset and id.</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ValidatorsApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Validators<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.ValidatorsApi.html" class="tsd-signature-type tsd-kind-class">ValidatorsApi</a><a href="#constructor.new_ValidatorsApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.ValidatorsApi.html" class="tsd-signature-type tsd-kind-class">ValidatorsApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getValidator" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Validator</span><a href="#getValidator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getValidator.getValidator-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Validator</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">validatorId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getValidator.getValidator-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a validator belonging to the user for a given network, asset and id.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to get the validator for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">validatorId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique id of the validator to fetch details for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a validator belonging to the CDP project</p> <h4>Throws</h4><h4>Memberof</h4><p>ValidatorsApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ValidatorsApiInterface.html">ValidatorsApiInterface</a>.<a href="../interfaces/client_api.ValidatorsApiInterface.html#getValidator">getValidator</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4795">src/client/api.ts:4795</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listValidators" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Validators</span><a href="#listValidators" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listValidators.listValidators-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Validators</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listValidators.listValidators-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List validators belonging to the user for a given network and asset.</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ValidatorsApiInterface.html">ValidatorsApiInterface</a>.<a href="../interfaces/client_api.ValidatorsApiInterface.html#getValidator">getValidator</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4795">src/client/api.ts:4795</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listValidators" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Validators</span><a href="#listValidators" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listValidators.listValidators-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Validators</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listValidators.listValidators-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List validators belonging to the user for a given network and asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to get the validators for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A filter to list validators based on a status.</p> @@ -22,4 +22,4 @@ <h4>Throws</h4><h4>Memberof</h4><p>ValidatorsApi</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List validators belonging to the CDP project</p> <h4>Throws</h4><h4>Memberof</h4><p>ValidatorsApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ValidatorsApiInterface.html">ValidatorsApiInterface</a>.<a href="../interfaces/client_api.ValidatorsApiInterface.html#listValidators">listValidators</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4811">src/client/api.ts:4811</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#getValidator" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Validator</span></a><a href="#listValidators" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Validators</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.ValidatorsApiInterface.html">ValidatorsApiInterface</a>.<a href="../interfaces/client_api.ValidatorsApiInterface.html#listValidators">listValidators</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4811">src/client/api.ts:4811</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#getValidator" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Validator</span></a><a href="#listValidators" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Validators</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/client_api.WalletsApi.html b/docs/classes/client_api.WalletsApi.html index a91b454a..565fc51e 100644 --- a/docs/classes/client_api.WalletsApi.html +++ b/docs/classes/client_api.WalletsApi.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WalletsApi | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.WalletsApi.html">WalletsApi</a></li></ul><h1>Class WalletsApi</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>WalletsApi - object-oriented interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>WalletsApi</p> -</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.WalletsApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">WalletsApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.WalletsApiInterface.html" class="tsd-signature-type tsd-kind-interface">WalletsApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5212">src/client/api.ts:5212</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.WalletsApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/api.WalletsApi">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><ul class="tsd-hierarchy"><li><span class="target">WalletsApi</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/client_api.WalletsApiInterface.html" class="tsd-signature-type tsd-kind-interface">WalletsApiInterface</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5212">src/client/api.ts:5212</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_api.WalletsApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.WalletsApi.html#axios" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a> <a href="client_api.WalletsApi.html#basePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a> <a href="client_api.WalletsApi.html#configuration" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a> @@ -9,30 +9,30 @@ <a href="client_api.WalletsApi.html#getWalletBalance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet<wbr/>Balance</span></a> <a href="client_api.WalletsApi.html#listWalletBalances" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallet<wbr/>Balances</span></a> <a href="client_api.WalletsApi.html#listWallets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallets</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_WalletsApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Wallets<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.WalletsApi.html" class="tsd-signature-type tsd-kind-class">WalletsApi</a><a href="#constructor.new_WalletsApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.WalletsApi.html" class="tsd-signature-type tsd-kind-class">WalletsApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="createWallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Wallet</span><a href="#createWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createWallet.createWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createWalletRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#createWallet.createWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new wallet scoped to the user.</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_WalletsApi" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Wallets<wbr/>Api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_api.WalletsApi.html" class="tsd-signature-type tsd-kind-class">WalletsApi</a><a href="#constructor.new_WalletsApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_api.WalletsApi.html" class="tsd-signature-type tsd-kind-class">WalletsApi</a></h4><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#basePath">basePath</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="client_base.BaseAPI.html">BaseAPI</a>.<a href="client_base.BaseAPI.html#configuration">configuration</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="createWallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Wallet</span><a href="#createWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createWallet.createWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createWalletRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#createWallet.createWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new wallet scoped to the user.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createWalletRequest</span>: <a href="../interfaces/client_api.CreateWalletRequest.html" class="tsd-signature-type tsd-kind-interface">CreateWalletRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new wallet</p> <h4>Throws</h4><h4>Memberof</h4><p>WalletsApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.WalletsApiInterface.html">WalletsApiInterface</a>.<a href="../interfaces/client_api.WalletsApiInterface.html#createWallet">createWallet</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5221">src/client/api.ts:5221</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet</span><a href="#getWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWallet.getWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getWallet.getWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get wallet</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.WalletsApiInterface.html">WalletsApiInterface</a>.<a href="../interfaces/client_api.WalletsApiInterface.html#createWallet">createWallet</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5221">src/client/api.ts:5221</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet</span><a href="#getWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWallet.getWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getWallet.getWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get wallet</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get wallet by ID</p> <h4>Throws</h4><h4>Memberof</h4><p>WalletsApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.WalletsApiInterface.html">WalletsApiInterface</a>.<a href="../interfaces/client_api.WalletsApiInterface.html#getWallet">getWallet</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5233">src/client/api.ts:5233</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWalletBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet<wbr/>Balance</span><a href="#getWalletBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWalletBalance.getWalletBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getWalletBalance.getWalletBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the aggregated balance of an asset across all of the addresses in the wallet.</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.WalletsApiInterface.html">WalletsApiInterface</a>.<a href="../interfaces/client_api.WalletsApiInterface.html#getWallet">getWallet</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5233">src/client/api.ts:5233</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWalletBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet<wbr/>Balance</span><a href="#getWalletBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWalletBalance.getWalletBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getWalletBalance.getWalletBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the aggregated balance of an asset across all of the addresses in the wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the balance of an asset in the wallet</p> <h4>Throws</h4><h4>Memberof</h4><p>WalletsApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.WalletsApiInterface.html">WalletsApiInterface</a>.<a href="../interfaces/client_api.WalletsApiInterface.html#getWalletBalance">getWalletBalance</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5246">src/client/api.ts:5246</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWalletBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Wallet<wbr/>Balances</span><a href="#listWalletBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWalletBalances.listWalletBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listWalletBalances.listWalletBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the balances of all of the addresses in the wallet aggregated by asset.</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.WalletsApiInterface.html">WalletsApiInterface</a>.<a href="../interfaces/client_api.WalletsApiInterface.html#getWalletBalance">getWalletBalance</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5246">src/client/api.ts:5246</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWalletBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Wallet<wbr/>Balances</span><a href="#listWalletBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWalletBalances.listWalletBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listWalletBalances.listWalletBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the balances of all of the addresses in the wallet aggregated by asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balances for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List wallet balances</p> <h4>Throws</h4><h4>Memberof</h4><p>WalletsApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.WalletsApiInterface.html">WalletsApiInterface</a>.<a href="../interfaces/client_api.WalletsApiInterface.html#listWalletBalances">listWalletBalances</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5258">src/client/api.ts:5258</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWallets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Wallets</span><a href="#listWallets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List wallets belonging to the user.</p> +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.WalletsApiInterface.html">WalletsApiInterface</a>.<a href="../interfaces/client_api.WalletsApiInterface.html#listWalletBalances">listWalletBalances</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5258">src/client/api.ts:5258</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWallets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Wallets</span><a href="#listWallets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List wallets belonging to the user.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List wallets</p> <h4>Throws</h4><h4>Memberof</h4><p>WalletsApi</p> -</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.WalletsApiInterface.html">WalletsApiInterface</a>.<a href="../interfaces/client_api.WalletsApiInterface.html#listWallets">listWallets</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5271">src/client/api.ts:5271</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#createWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Wallet</span></a><a href="#getWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet</span></a><a href="#getWalletBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet<wbr/>Balance</span></a><a href="#listWalletBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallet<wbr/>Balances</span></a><a href="#listWallets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallets</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/client_api.WalletsApiInterface.html">WalletsApiInterface</a>.<a href="../interfaces/client_api.WalletsApiInterface.html#listWallets">listWallets</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5271">src/client/api.ts:5271</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a><a href="#createWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Wallet</span></a><a href="#getWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet</span></a><a href="#getWalletBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet<wbr/>Balance</span></a><a href="#listWalletBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallet<wbr/>Balances</span></a><a href="#listWallets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallets</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/client_base.BaseAPI.html b/docs/classes/client_base.BaseAPI.html index 8a69bc11..94e5dd9d 100644 --- a/docs/classes/client_base.BaseAPI.html +++ b/docs/classes/client_base.BaseAPI.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BaseAPI | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_base.html">client/base</a></li><li><a href="client_base.BaseAPI.html">BaseAPI</a></li></ul><h1>Class BaseAPI</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>BaseAPI</p> -</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/base.BaseAPI">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">BaseAPI</span><ul class="tsd-hierarchy"><li><a href="client_api.AddressesApi.html" class="tsd-signature-type tsd-kind-class">AddressesApi</a></li><li><a href="client_api.AssetsApi.html" class="tsd-signature-type tsd-kind-class">AssetsApi</a></li><li><a href="client_api.ExternalAddressesApi.html" class="tsd-signature-type tsd-kind-class">ExternalAddressesApi</a></li><li><a href="client_api.ServerSignersApi.html" class="tsd-signature-type tsd-kind-class">ServerSignersApi</a></li><li><a href="client_api.StakeApi.html" class="tsd-signature-type tsd-kind-class">StakeApi</a></li><li><a href="client_api.TradesApi.html" class="tsd-signature-type tsd-kind-class">TradesApi</a></li><li><a href="client_api.TransfersApi.html" class="tsd-signature-type tsd-kind-class">TransfersApi</a></li><li><a href="client_api.UsersApi.html" class="tsd-signature-type tsd-kind-class">UsersApi</a></li><li><a href="client_api.ValidatorsApi.html" class="tsd-signature-type tsd-kind-class">ValidatorsApi</a></li><li><a href="client_api.WalletsApi.html" class="tsd-signature-type tsd-kind-class">WalletsApi</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L50">src/client/base.ts:50</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_base.BaseAPI.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#client/base.BaseAPI">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">BaseAPI</span><ul class="tsd-hierarchy"><li><a href="client_api.AddressesApi.html" class="tsd-signature-type tsd-kind-class">AddressesApi</a></li><li><a href="client_api.AssetsApi.html" class="tsd-signature-type tsd-kind-class">AssetsApi</a></li><li><a href="client_api.ExternalAddressesApi.html" class="tsd-signature-type tsd-kind-class">ExternalAddressesApi</a></li><li><a href="client_api.ServerSignersApi.html" class="tsd-signature-type tsd-kind-class">ServerSignersApi</a></li><li><a href="client_api.StakeApi.html" class="tsd-signature-type tsd-kind-class">StakeApi</a></li><li><a href="client_api.TradesApi.html" class="tsd-signature-type tsd-kind-class">TradesApi</a></li><li><a href="client_api.TransfersApi.html" class="tsd-signature-type tsd-kind-class">TransfersApi</a></li><li><a href="client_api.UsersApi.html" class="tsd-signature-type tsd-kind-class">UsersApi</a></li><li><a href="client_api.ValidatorsApi.html" class="tsd-signature-type tsd-kind-class">ValidatorsApi</a></li><li><a href="client_api.WalletsApi.html" class="tsd-signature-type tsd-kind-class">WalletsApi</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L50">src/client/base.ts:50</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_base.BaseAPI.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_base.BaseAPI.html#axios" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a> <a href="client_base.BaseAPI.html#basePath" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a> <a href="client_base.BaseAPI.html#configuration" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_BaseAPI" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>BaseAPI</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><a href="#constructor.new_BaseAPI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_BaseAPI" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>BaseAPI</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a><a href="#constructor.new_BaseAPI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L53">src/client/base.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="configuration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L51">src/client/base.ts:51</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#axios" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axios</span></a><a href="#basePath" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#configuration" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/client_base.RequiredError.html b/docs/classes/client_base.RequiredError.html index 649b5a3d..d5bb4099 100644 --- a/docs/classes/client_base.RequiredError.html +++ b/docs/classes/client_base.RequiredError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RequiredError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_base.html">client/base</a></li><li><a href="client_base.RequiredError.html">RequiredError</a></li></ul><h1>Class RequiredError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>RequiredError</p> -</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">RequiredError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L67">src/client/base.ts:67</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_base.RequiredError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">RequiredError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L67">src/client/base.ts:67</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_base.RequiredError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_base.RequiredError.html#field" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field</span></a> <a href="client_base.RequiredError.html#message" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a> <a href="client_base.RequiredError.html#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a> @@ -7,7 +7,7 @@ <a href="client_base.RequiredError.html#prepareStackTrace" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a> <a href="client_base.RequiredError.html#stackTraceLimit" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_base.RequiredError.html#captureStackTrace" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_RequiredError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Required<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">field</span>, <span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_base.RequiredError.html" class="tsd-signature-type tsd-kind-class">RequiredError</a><a href="#constructor.new_RequiredError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">field</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_base.RequiredError.html" class="tsd-signature-type tsd-kind-class">RequiredError</a></h4><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L68">src/client/base.ts:68</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="field" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field</span><a href="#field" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">field</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L68">src/client/base.ts:68</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_RequiredError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Required<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">field</span>, <span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_base.RequiredError.html" class="tsd-signature-type tsd-kind-class">RequiredError</a><a href="#constructor.new_RequiredError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">field</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_base.RequiredError.html" class="tsd-signature-type tsd-kind-class">RequiredError</a></h4><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L68">src/client/base.ts:68</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="field" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field</span><a href="#field" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">field</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L68">src/client/base.ts:68</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from Error.prepareStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Error.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Error.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#field" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/client_configuration.Configuration.html b/docs/classes/client_configuration.Configuration.html index 0437be58..abd244c3 100644 --- a/docs/classes/client_configuration.Configuration.html +++ b/docs/classes/client_configuration.Configuration.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Configuration | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_configuration.html">client/configuration</a></li><li><a href="client_configuration.Configuration.html">Configuration</a></li></ul><h1>Class Configuration</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L27">src/client/configuration.ts:27</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_configuration.Configuration.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Configuration | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_configuration.html">client/configuration</a></li><li><a href="client_configuration.Configuration.html">Configuration</a></li></ul><h1>Class Configuration</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L27">src/client/configuration.ts:27</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="client_configuration.Configuration.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_configuration.Configuration.html#accessToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>access<wbr/>Token?</span></a> <a href="client_configuration.Configuration.html#apiKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key?</span></a> <a href="client_configuration.Configuration.html#baseOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Options?</span></a> @@ -8,27 +8,27 @@ <a href="client_configuration.Configuration.html#serverIndex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Index?</span></a> <a href="client_configuration.Configuration.html#username" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username?</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_configuration.Configuration.html#isJsonMime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Json<wbr/>Mime</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Configuration" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Configuration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">param</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a><a href="#constructor.new_Configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">param</span>: <a href="../interfaces/client_configuration.ConfigurationParameters.html" class="tsd-signature-type tsd-kind-interface">ConfigurationParameters</a><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L85">src/client/configuration.ts:85</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="accessToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>access<wbr/>Token</span><a href="#accessToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">access<wbr/>Token</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>parameter for oauth2 security</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Configuration" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Configuration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">param</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a><a href="#constructor.new_Configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">param</span>: <a href="../interfaces/client_configuration.ConfigurationParameters.html" class="tsd-signature-type tsd-kind-interface">ConfigurationParameters</a><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L85">src/client/configuration.ts:85</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="accessToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>access<wbr/>Token</span><a href="#accessToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">access<wbr/>Token</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>parameter for oauth2 security</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">scopes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">scopes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>Param: name</h4><p>security name</p> <h4>Param: scopes</h4><p>oauth2 scope</p> <h4>Memberof</h4><p>Configuration</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L54">src/client/configuration.ts:54</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="apiKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api<wbr/>Key</span><a href="#apiKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>parameter for apiKey security</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L54">src/client/configuration.ts:54</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="apiKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api<wbr/>Key</span><a href="#apiKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>parameter for apiKey security</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>Param: name</h4><p>security name</p> <h4>Memberof</h4><p>Configuration</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L33">src/client/configuration.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="baseOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>base<wbr/>Options</span><a href="#baseOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>base options for axios calls</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L33">src/client/configuration.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="baseOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>base<wbr/>Options</span><a href="#baseOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>base options for axios calls</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Configuration</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L75">src/client/configuration.ts:75</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>override base path</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L75">src/client/configuration.ts:75</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>override base path</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Configuration</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L61">src/client/configuration.ts:61</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="formDataCtor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>form<wbr/>Data<wbr/>Ctor</span><a href="#formDataCtor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">form<wbr/>Data<wbr/>Ctor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">new </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>The FormData constructor that will be used to create multipart form data +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L61">src/client/configuration.ts:61</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="formDataCtor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>form<wbr/>Data<wbr/>Ctor</span><a href="#formDataCtor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">form<wbr/>Data<wbr/>Ctor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">new </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>The FormData constructor that will be used to create multipart form data requests. You can inject this here so that execution environments that do not support the FormData class can still run the generated client.</p> -</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="formDataCtor.__type.new_formDataCtor"><span class="tsd-signature-keyword">new </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L83">src/client/configuration.ts:83</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="password" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>password</span><a href="#password" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>parameter for basic security</p> +</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="formDataCtor.__type.new_formDataCtor"><span class="tsd-signature-keyword">new </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L83">src/client/configuration.ts:83</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="password" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>password</span><a href="#password" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>parameter for basic security</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Configuration</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L47">src/client/configuration.ts:47</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="serverIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>server<wbr/>Index</span><a href="#serverIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">server<wbr/>Index</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>override server index</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L47">src/client/configuration.ts:47</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="serverIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>server<wbr/>Index</span><a href="#serverIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">server<wbr/>Index</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>override server index</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Configuration</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L68">src/client/configuration.ts:68</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="username" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>username</span><a href="#username" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>parameter for basic security</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L68">src/client/configuration.ts:68</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="username" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>username</span><a href="#username" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>parameter for basic security</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Configuration</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L40">src/client/configuration.ts:40</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="isJsonMime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Json<wbr/>Mime</span><a href="#isJsonMime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isJsonMime.isJsonMime-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Json<wbr/>Mime</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mime</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isJsonMime.isJsonMime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if the given MIME is a JSON MIME. +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L40">src/client/configuration.ts:40</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="isJsonMime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Json<wbr/>Mime</span><a href="#isJsonMime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isJsonMime.isJsonMime-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Json<wbr/>Mime</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mime</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isJsonMime.isJsonMime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 @@ -36,4 +36,4 @@ <h4>Memberof</h4><p>Configuration</p> application/vnd.company+json</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mime</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>MIME (Multipurpose Internet Mail Extensions)</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>True if the given MIME is JSON, false otherwise.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L106">src/client/configuration.ts:106</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#accessToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>access<wbr/>Token</span></a><a href="#apiKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key</span></a><a href="#baseOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Options</span></a><a href="#basePath" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#formDataCtor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Data<wbr/>Ctor</span></a><a href="#password" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>password</span></a><a href="#serverIndex" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Index</span></a><a href="#username" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username</span></a><a href="#isJsonMime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Json<wbr/>Mime</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L106">src/client/configuration.ts:106</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#accessToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>access<wbr/>Token</span></a><a href="#apiKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key</span></a><a href="#baseOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Options</span></a><a href="#basePath" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#formDataCtor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Data<wbr/>Ctor</span></a><a href="#password" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>password</span></a><a href="#serverIndex" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Index</span></a><a href="#username" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username</span></a><a href="#isJsonMime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Json<wbr/>Mime</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_address.Address.html b/docs/classes/coinbase_address.Address.html index fffa35f3..96f346aa 100644 --- a/docs/classes/coinbase_address.Address.html +++ b/docs/classes/coinbase_address.Address.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Address | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_address.html">coinbase/address</a></li><li><a href="coinbase_address.Address.html">Address</a></li></ul><h1>Class Address</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of a blockchain address, which is a user-controlled account on a network.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/address.Address">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">Address</span><ul class="tsd-hierarchy"><li><a href="coinbase_address_external_address.ExternalAddress.html" class="tsd-signature-type tsd-kind-class">ExternalAddress</a></li><li><a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L11">src/coinbase/address.ts:11</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_address.Address.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/address.Address">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">Address</span><ul class="tsd-hierarchy"><li><a href="coinbase_address_external_address.ExternalAddress.html" class="tsd-signature-type tsd-kind-class">ExternalAddress</a></li><li><a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L11">src/coinbase/address.ts:11</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_address.Address.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_address.Address.html#id" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a> <a href="coinbase_address.Address.html#networkId" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_address.Address.html#faucet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>faucet</span></a> @@ -11,20 +11,20 @@ </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Address" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a><a href="#constructor.new_Address" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new Address instance.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The network id.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address id.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L21">src/coinbase/address.ts:21</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L13">src/coinbase/address.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="networkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>network<wbr/>Id</span><a href="#networkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L12">src/coinbase/address.ts:12</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="faucet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>faucet</span><a href="#faucet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="faucet.faucet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">faucet</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#faucet.faucet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests faucet funds for the address. +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L21">src/coinbase/address.ts:21</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L13">src/coinbase/address.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="networkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>network<wbr/>Id</span><a href="#networkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L12">src/coinbase/address.ts:12</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="faucet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>faucet</span><a href="#faucet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="faucet.faucet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">faucet</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#faucet.faucet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests faucet funds for the address. Only supported on testnet networks.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a><span class="tsd-signature-symbol">></span></h4><p>The faucet transaction object.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request does not return a transaction hash.</p> <h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L86">src/coinbase/address.ts:86</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Balance</span><a href="#getBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getBalance.getBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#getBalance.getBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the balance of the provided asset.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L86">src/coinbase/address.ts:86</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Balance</span><a href="#getBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getBalance.getBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#getBalance.getBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the balance of the provided asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset ID.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span></h4><p>The balance of the asset.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L64">src/coinbase/address.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the address ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L64">src/coinbase/address.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the address ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The address ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L40">src/coinbase/address.ts:40</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getNetworkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Network<wbr/>Id</span><a href="#getNetworkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getNetworkId.getNetworkId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Network<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getNetworkId.getNetworkId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the network ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L40">src/coinbase/address.ts:40</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getNetworkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Network<wbr/>Id</span><a href="#getNetworkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getNetworkId.getNetworkId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Network<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getNetworkId.getNetworkId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the network ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The network ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L31">src/coinbase/address.ts:31</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Balances</span><a href="#listBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listBalances.listBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><span class="tsd-signature-symbol">></span><a href="#listBalances.listBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of balances for the address.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L31">src/coinbase/address.ts:31</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Balances</span><a href="#listBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listBalances.listBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><span class="tsd-signature-symbol">></span><a href="#listBalances.listBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of balances for the address.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><span class="tsd-signature-symbol">></span></h4><p>The map from asset ID to balance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L49">src/coinbase/address.ts:49</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the address.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L49">src/coinbase/address.ts:49</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the address.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A string representing the address.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L99">src/coinbase/address.ts:99</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#networkId" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a><a href="#faucet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>faucet</span></a><a href="#getBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Balance</span></a><a href="#getId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getNetworkId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Network<wbr/>Id</span></a><a href="#listBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Balances</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L99">src/coinbase/address.ts:99</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#networkId" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a><a href="#faucet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>faucet</span></a><a href="#getBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Balance</span></a><a href="#getId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getNetworkId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Network<wbr/>Id</span></a><a href="#listBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Balances</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_address_external_address.ExternalAddress.html b/docs/classes/coinbase_address_external_address.ExternalAddress.html index f79cf1d9..f7d600f8 100644 --- a/docs/classes/coinbase_address_external_address.ExternalAddress.html +++ b/docs/classes/coinbase_address_external_address.ExternalAddress.html @@ -1,7 +1,7 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ExternalAddress | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_address_external_address.html">coinbase/address/external_address</a></li><li><a href="coinbase_address_external_address.ExternalAddress.html">ExternalAddress</a></li></ul><h1>Class ExternalAddress</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of a blockchain Address, which is a user-controlled account on a Network. Addresses are used to send and receive Assets. An ExternalAddress is an Address that is not controlled by the developer, but is instead controlled by the user.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/address/external_address.ExternalAddress">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a><ul class="tsd-hierarchy"><li><span class="target">ExternalAddress</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L18">src/coinbase/address/external_address.ts:18</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_address_external_address.ExternalAddress.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/address/external_address.ExternalAddress">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a><ul class="tsd-hierarchy"><li><span class="target">ExternalAddress</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L18">src/coinbase/address/external_address.ts:18</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_address_external_address.ExternalAddress.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_address_external_address.ExternalAddress.html#id" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a> <a href="coinbase_address_external_address.ExternalAddress.html#networkId" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_address_external_address.ExternalAddress.html#buildClaimStakeOperation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Claim<wbr/>Stake<wbr/>Operation</span></a> @@ -26,20 +26,20 @@ </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ExternalAddress" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>External<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_address_external_address.ExternalAddress.html" class="tsd-signature-type tsd-kind-class">ExternalAddress</a><a href="#constructor.new_ExternalAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new Address instance.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The network id.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address id.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_address_external_address.ExternalAddress.html" class="tsd-signature-type tsd-kind-class">ExternalAddress</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L21">src/coinbase/address.ts:21</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L13">src/coinbase/address.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="networkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>network<wbr/>Id</span><a href="#networkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#networkId">networkId</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L12">src/coinbase/address.ts:12</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="buildClaimStakeOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build<wbr/>Claim<wbr/>Stake<wbr/>Operation</span><a href="#buildClaimStakeOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="buildClaimStakeOperation.buildClaimStakeOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Claim<wbr/>Stake<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#buildClaimStakeOperation.buildClaimStakeOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Builds a claim stake operation for the supplied asset.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_address_external_address.ExternalAddress.html" class="tsd-signature-type tsd-kind-class">ExternalAddress</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L21">src/coinbase/address.ts:21</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L13">src/coinbase/address.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="networkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>network<wbr/>Id</span><a href="#networkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#networkId">networkId</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L12">src/coinbase/address.ts:12</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="buildClaimStakeOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build<wbr/>Claim<wbr/>Stake<wbr/>Operation</span><a href="#buildClaimStakeOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="buildClaimStakeOperation.buildClaimStakeOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Claim<wbr/>Stake<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#buildClaimStakeOperation.buildClaimStakeOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Builds a claim stake operation for the supplied asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">amount</span>: <a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></span><div class="tsd-comment tsd-typography"><p>The amount of the asset to claim stake.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset to claim stake.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mode</span>: <a href="../enums/coinbase_types.StakeOptionsMode.html" class="tsd-signature-type tsd-kind-enum">StakeOptionsMode</a><span class="tsd-signature-symbol"> = StakeOptionsMode.DEFAULT</span></span><div class="tsd-comment tsd-typography"><p>The staking mode. Defaults to DEFAULT.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Additional options for the claim stake operation.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><span class="tsd-signature-symbol">></span></h4><p>The claim stake operation.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L67">src/coinbase/address/external_address.ts:67</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="buildStakeOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build<wbr/>Stake<wbr/>Operation</span><a href="#buildStakeOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="buildStakeOperation.buildStakeOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Stake<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#buildStakeOperation.buildStakeOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Builds a stake operation for the supplied asset. The stake operation +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L67">src/coinbase/address/external_address.ts:67</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="buildStakeOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build<wbr/>Stake<wbr/>Operation</span><a href="#buildStakeOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="buildStakeOperation.buildStakeOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Stake<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#buildStakeOperation.buildStakeOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Builds a stake operation for the supplied asset. The stake operation may take a few minutes to complete in the case when infrastructure is spun up.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">amount</span>: <a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></span><div class="tsd-comment tsd-typography"><p>The amount of the asset to stake.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset to stake.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mode</span>: <a href="../enums/coinbase_types.StakeOptionsMode.html" class="tsd-signature-type tsd-kind-enum">StakeOptionsMode</a><span class="tsd-signature-symbol"> = StakeOptionsMode.DEFAULT</span></span><div class="tsd-comment tsd-typography"><p>The staking mode. Defaults to DEFAULT.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Additional options for the stake operation.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><span class="tsd-signature-symbol">></span></h4><p>The stake operation.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L29">src/coinbase/address/external_address.ts:29</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="buildStakingOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>build<wbr/>Staking<wbr/>Operation</span><a href="#buildStakingOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="buildStakingOperation.buildStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">action</span>, <span class="tsd-kind-parameter">mode</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#buildStakingOperation.buildStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagPrivate">Private</code> <div class="tsd-comment tsd-typography"><p>Builds the staking operation based on the supplied input.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L29">src/coinbase/address/external_address.ts:29</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="buildStakingOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>build<wbr/>Staking<wbr/>Operation</span><a href="#buildStakingOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="buildStakingOperation.buildStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">action</span>, <span class="tsd-kind-parameter">mode</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#buildStakingOperation.buildStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagPrivate">Private</code> <div class="tsd-comment tsd-typography"><p>Builds the staking operation based on the supplied input.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">amount</span>: <a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></span><div class="tsd-comment tsd-typography"><p>The amount for the staking operation.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset for the staking operation.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">action</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The specific action for the staking operation. e.g. stake, unstake, claim_stake</p> @@ -47,73 +47,73 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Additional options to build a stake operation.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><span class="tsd-signature-symbol">></span></h4><p>The staking operation.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the supplied input cannot build a valid staking operation.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L289">src/coinbase/address/external_address.ts:289</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="buildUnstakeOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build<wbr/>Unstake<wbr/>Operation</span><a href="#buildUnstakeOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="buildUnstakeOperation.buildUnstakeOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Unstake<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#buildUnstakeOperation.buildUnstakeOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Builds an unstake operation for the supplied asset.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L289">src/coinbase/address/external_address.ts:289</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="buildUnstakeOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build<wbr/>Unstake<wbr/>Operation</span><a href="#buildUnstakeOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="buildUnstakeOperation.buildUnstakeOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Unstake<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#buildUnstakeOperation.buildUnstakeOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Builds an unstake operation for the supplied asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">amount</span>: <a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></span><div class="tsd-comment tsd-typography"><p>The amount of the asset to unstake.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset to unstake.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mode</span>: <a href="../enums/coinbase_types.StakeOptionsMode.html" class="tsd-signature-type tsd-kind-enum">StakeOptionsMode</a><span class="tsd-signature-symbol"> = StakeOptionsMode.DEFAULT</span></span><div class="tsd-comment tsd-typography"><p>The staking mode. Defaults to DEFAULT.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Additional options for the unstake operation.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><span class="tsd-signature-symbol">></span></h4><p>The unstake operation.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L48">src/coinbase/address/external_address.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="claimableBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>claimable<wbr/>Balance</span><a href="#claimableBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="claimableBalance.claimableBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">claimable<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">asset_id</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#claimableBalance.claimableBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the claimable balance for the supplied asset.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L48">src/coinbase/address/external_address.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="claimableBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>claimable<wbr/>Balance</span><a href="#claimableBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="claimableBalance.claimableBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">claimable<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">asset_id</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#claimableBalance.claimableBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the claimable balance for the supplied asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">asset_id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset to check claimable balance for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mode</span>: <a href="../enums/coinbase_types.StakeOptionsMode.html" class="tsd-signature-type tsd-kind-enum">StakeOptionsMode</a><span class="tsd-signature-symbol"> = StakeOptionsMode.DEFAULT</span></span><div class="tsd-comment tsd-typography"><p>The staking mode. Defaults to DEFAULT.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Additional options for getting the claimable balance.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span></h4><p>The claimable balance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L119">src/coinbase/address/external_address.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="copyOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>copy<wbr/>Options</span><a href="#copyOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="copyOptions.copyOptions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">copy<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><a href="#copyOptions.copyOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagPrivate">Private</code> <div class="tsd-comment tsd-typography"><p>Create a shallow copy of given options.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L119">src/coinbase/address/external_address.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="copyOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>copy<wbr/>Options</span><a href="#copyOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="copyOptions.copyOptions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">copy<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><a href="#copyOptions.copyOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagPrivate">Private</code> <div class="tsd-comment tsd-typography"><p>Create a shallow copy of given options.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>The supplied options to be copied</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><p>A copy of the options.</p> -<ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L327">src/coinbase/address/external_address.ts:327</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="faucet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>faucet</span><a href="#faucet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="faucet.faucet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">faucet</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#faucet.faucet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests faucet funds for the address. +<ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L327">src/coinbase/address/external_address.ts:327</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="faucet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>faucet</span><a href="#faucet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="faucet.faucet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">faucet</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#faucet.faucet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests faucet funds for the address. Only supported on testnet networks.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a><span class="tsd-signature-symbol">></span></h4><p>The faucet transaction object.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request does not return a transaction hash.</p> <h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#faucet">faucet</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L86">src/coinbase/address.ts:86</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Balance</span><a href="#getBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getBalance.getBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#getBalance.getBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the balance of the provided asset.</p> +</div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#faucet">faucet</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L86">src/coinbase/address.ts:86</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Balance</span><a href="#getBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getBalance.getBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#getBalance.getBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the balance of the provided asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset ID.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span></h4><p>The balance of the asset.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#getBalance">getBalance</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L64">src/coinbase/address.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the address ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#getBalance">getBalance</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L64">src/coinbase/address.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the address ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The address ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#getId">getId</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L40">src/coinbase/address.ts:40</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getNetworkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Network<wbr/>Id</span><a href="#getNetworkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getNetworkId.getNetworkId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Network<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getNetworkId.getNetworkId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the network ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#getId">getId</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L40">src/coinbase/address.ts:40</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getNetworkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Network<wbr/>Id</span><a href="#getNetworkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getNetworkId.getNetworkId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Network<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getNetworkId.getNetworkId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the network ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The network ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#getNetworkId">getNetworkId</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L31">src/coinbase/address.ts:31</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getStakingBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Staking<wbr/>Balances</span><a href="#getStakingBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getStakingBalances.getStakingBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Staking<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#getStakingBalances.getStakingBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagPrivate">Private</code> <div class="tsd-comment tsd-typography"><p>Get the different staking balance types for the supplied asset.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#getNetworkId">getNetworkId</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L31">src/coinbase/address.ts:31</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getStakingBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Staking<wbr/>Balances</span><a href="#getStakingBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getStakingBalances.getStakingBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Staking<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#getStakingBalances.getStakingBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagPrivate">Private</code> <div class="tsd-comment tsd-typography"><p>Get the different staking balance types for the supplied asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset to lookup balances for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">mode</span>: <a href="../enums/coinbase_types.StakeOptionsMode.html" class="tsd-signature-type tsd-kind-enum">StakeOptionsMode</a></span><div class="tsd-comment tsd-typography"><p>The staking mode. Defaults to DEFAULT.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Additional options for the balance lookup.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><p>The different balance types.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L241">src/coinbase/address/external_address.ts:241</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="listBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Balances</span><a href="#listBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="listBalances.listBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><span class="tsd-signature-symbol">></span><a href="#listBalances.listBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of balances for the address.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L241">src/coinbase/address/external_address.ts:241</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="listBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Balances</span><a href="#listBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="listBalances.listBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><span class="tsd-signature-symbol">></span><a href="#listBalances.listBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of balances for the address.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><span class="tsd-signature-symbol">></span></h4><p>The map from asset ID to balance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#listBalances">listBalances</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L49">src/coinbase/address.ts:49</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="stakeableBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stakeable<wbr/>Balance</span><a href="#stakeableBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="stakeableBalance.stakeableBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stakeable<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">asset_id</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#stakeableBalance.stakeableBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the stakeable balance for the supplied asset.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#listBalances">listBalances</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L49">src/coinbase/address.ts:49</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="stakeableBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stakeable<wbr/>Balance</span><a href="#stakeableBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="stakeableBalance.stakeableBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stakeable<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">asset_id</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#stakeableBalance.stakeableBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the stakeable balance for the supplied asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">asset_id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset to check the stakeable balance for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mode</span>: <a href="../enums/coinbase_types.StakeOptionsMode.html" class="tsd-signature-type tsd-kind-enum">StakeOptionsMode</a><span class="tsd-signature-symbol"> = StakeOptionsMode.DEFAULT</span></span><div class="tsd-comment tsd-typography"><p>The staking mode. Defaults to DEFAULT.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Additional options for getting the stakeable balance.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span></h4><p>The stakeable balance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L85">src/coinbase/address/external_address.ts:85</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="stakingRewards" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>staking<wbr/>Rewards</span><a href="#stakingRewards" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="stakingRewards.stakingRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">staking<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">startTime</span>, <span class="tsd-kind-parameter">endTime</span>, <span class="tsd-kind-parameter">format</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_reward.StakingReward.html" class="tsd-signature-type tsd-kind-class">StakingReward</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#stakingRewards.stakingRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists the staking rewards for the address.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L85">src/coinbase/address/external_address.ts:85</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="stakingRewards" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>staking<wbr/>Rewards</span><a href="#stakingRewards" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="stakingRewards.stakingRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">staking<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">startTime</span>, <span class="tsd-kind-parameter">endTime</span>, <span class="tsd-kind-parameter">format</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_reward.StakingReward.html" class="tsd-signature-type tsd-kind-class">StakingReward</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#stakingRewards.stakingRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists the staking rewards for the address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset ID.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">startTime</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The start time.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">endTime</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The end time.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">format</span>: <a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a><span class="tsd-signature-symbol"> = StakingRewardFormat.Usd</span></span><div class="tsd-comment tsd-typography"><p>The format to return the rewards in. (usd, native). Defaults to usd.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_reward.StakingReward.html" class="tsd-signature-type tsd-kind-class">StakingReward</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The staking rewards.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L137">src/coinbase/address/external_address.ts:137</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the address.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L137">src/coinbase/address/external_address.ts:137</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the address.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A string representing the address.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L99">src/coinbase/address.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="unstakeableBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unstakeable<wbr/>Balance</span><a href="#unstakeableBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="unstakeableBalance.unstakeableBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unstakeable<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">asset_id</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#unstakeableBalance.unstakeableBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the unstakeable balance for the supplied asset.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L99">src/coinbase/address.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="unstakeableBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unstakeable<wbr/>Balance</span><a href="#unstakeableBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="unstakeableBalance.unstakeableBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unstakeable<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">asset_id</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#unstakeableBalance.unstakeableBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the unstakeable balance for the supplied asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">asset_id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset to check the unstakeable balance for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mode</span>: <a href="../enums/coinbase_types.StakeOptionsMode.html" class="tsd-signature-type tsd-kind-enum">StakeOptionsMode</a><span class="tsd-signature-symbol"> = StakeOptionsMode.DEFAULT</span></span><div class="tsd-comment tsd-typography"><p>The staking mode. Defaults to DEFAULT.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Additional options for getting the unstakeable balance.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span></h4><p>The unstakeable balance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L102">src/coinbase/address/external_address.ts:102</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="validateCanClaimStake" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Can<wbr/>Claim<wbr/>Stake</span><a href="#validateCanClaimStake" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="validateCanClaimStake.validateCanClaimStake-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Can<wbr/>Claim<wbr/>Stake</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#validateCanClaimStake.validateCanClaimStake-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagPrivate">Private</code> <div class="tsd-comment tsd-typography"><p>Validate if the operation is able to claim stake with the supplied input.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L102">src/coinbase/address/external_address.ts:102</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="validateCanClaimStake" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Can<wbr/>Claim<wbr/>Stake</span><a href="#validateCanClaimStake" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="validateCanClaimStake.validateCanClaimStake-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Can<wbr/>Claim<wbr/>Stake</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#validateCanClaimStake.validateCanClaimStake-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagPrivate">Private</code> <div class="tsd-comment tsd-typography"><p>Validate if the operation is able to claim stake with the supplied input.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">amount</span>: <a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></span><div class="tsd-comment tsd-typography"><p>The amount of the asset to claim stake.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset to claim stake.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mode</span>: <a href="../enums/coinbase_types.StakeOptionsMode.html" class="tsd-signature-type tsd-kind-enum">StakeOptionsMode</a></span><div class="tsd-comment tsd-typography"><p>The staking mode. Defaults to DEFAULT.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Additional options for the claim stake operation.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the supplied input is not able to create a claim stake operation.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L213">src/coinbase/address/external_address.ts:213</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="validateCanStake" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Can<wbr/>Stake</span><a href="#validateCanStake" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="validateCanStake.validateCanStake-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Can<wbr/>Stake</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#validateCanStake.validateCanStake-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagPrivate">Private</code> <div class="tsd-comment tsd-typography"><p>Validate if the operation is able to stake with the supplied input.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L213">src/coinbase/address/external_address.ts:213</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="validateCanStake" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Can<wbr/>Stake</span><a href="#validateCanStake" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="validateCanStake.validateCanStake-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Can<wbr/>Stake</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#validateCanStake.validateCanStake-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagPrivate">Private</code> <div class="tsd-comment tsd-typography"><p>Validate if the operation is able to stake with the supplied input.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">amount</span>: <a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></span><div class="tsd-comment tsd-typography"><p>The amount of the asset to stake.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset to stake.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mode</span>: <a href="../enums/coinbase_types.StakeOptionsMode.html" class="tsd-signature-type tsd-kind-enum">StakeOptionsMode</a></span><div class="tsd-comment tsd-typography"><p>The staking mode. Defaults to DEFAULT.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Additional options for the stake operation.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the supplied input is not able to create a stake operation.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L163">src/coinbase/address/external_address.ts:163</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="validateCanUnstake" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Can<wbr/>Unstake</span><a href="#validateCanUnstake" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="validateCanUnstake.validateCanUnstake-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Can<wbr/>Unstake</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#validateCanUnstake.validateCanUnstake-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagPrivate">Private</code> <div class="tsd-comment tsd-typography"><p>Validate if the operation is able to unstake with the supplied input.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L163">src/coinbase/address/external_address.ts:163</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="validateCanUnstake" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Can<wbr/>Unstake</span><a href="#validateCanUnstake" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="validateCanUnstake.validateCanUnstake-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Can<wbr/>Unstake</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">mode</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#validateCanUnstake.validateCanUnstake-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagPrivate">Private</code> <div class="tsd-comment tsd-typography"><p>Validate if the operation is able to unstake with the supplied input.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">amount</span>: <a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></span><div class="tsd-comment tsd-typography"><p>The amount of the asset to unstake.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset to unstake.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mode</span>: <a href="../enums/coinbase_types.StakeOptionsMode.html" class="tsd-signature-type tsd-kind-enum">StakeOptionsMode</a></span><div class="tsd-comment tsd-typography"><p>The staking mode. Defaults to DEFAULT.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Additional options for the unstake operation.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the supplied input is not able to create an unstake operation.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L188">src/coinbase/address/external_address.ts:188</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#networkId" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a><a href="#buildClaimStakeOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Claim<wbr/>Stake<wbr/>Operation</span></a><a href="#buildStakeOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Stake<wbr/>Operation</span></a><a href="#buildStakingOperation" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Staking<wbr/>Operation</span></a><a href="#buildUnstakeOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Unstake<wbr/>Operation</span></a><a href="#claimableBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>claimable<wbr/>Balance</span></a><a href="#copyOptions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>copy<wbr/>Options</span></a><a href="#faucet" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>faucet</span></a><a href="#getBalance" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Balance</span></a><a href="#getId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getNetworkId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Network<wbr/>Id</span></a><a href="#getStakingBalances" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Staking<wbr/>Balances</span></a><a href="#listBalances" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Balances</span></a><a href="#stakeableBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stakeable<wbr/>Balance</span></a><a href="#stakingRewards" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>staking<wbr/>Rewards</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#unstakeableBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unstakeable<wbr/>Balance</span></a><a href="#validateCanClaimStake" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Can<wbr/>Claim<wbr/>Stake</span></a><a href="#validateCanStake" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Can<wbr/>Stake</span></a><a href="#validateCanUnstake" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Can<wbr/>Unstake</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L188">src/coinbase/address/external_address.ts:188</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#networkId" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a><a href="#buildClaimStakeOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Claim<wbr/>Stake<wbr/>Operation</span></a><a href="#buildStakeOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Stake<wbr/>Operation</span></a><a href="#buildStakingOperation" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Staking<wbr/>Operation</span></a><a href="#buildUnstakeOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Unstake<wbr/>Operation</span></a><a href="#claimableBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>claimable<wbr/>Balance</span></a><a href="#copyOptions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>copy<wbr/>Options</span></a><a href="#faucet" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>faucet</span></a><a href="#getBalance" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Balance</span></a><a href="#getId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getNetworkId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Network<wbr/>Id</span></a><a href="#getStakingBalances" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Staking<wbr/>Balances</span></a><a href="#listBalances" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Balances</span></a><a href="#stakeableBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stakeable<wbr/>Balance</span></a><a href="#stakingRewards" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>staking<wbr/>Rewards</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#unstakeableBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unstakeable<wbr/>Balance</span></a><a href="#validateCanClaimStake" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Can<wbr/>Claim<wbr/>Stake</span></a><a href="#validateCanStake" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Can<wbr/>Stake</span></a><a href="#validateCanUnstake" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Can<wbr/>Unstake</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_address_wallet_address.WalletAddress.html b/docs/classes/coinbase_address_wallet_address.WalletAddress.html index 245d884b..f0544c31 100644 --- a/docs/classes/coinbase_address_wallet_address.WalletAddress.html +++ b/docs/classes/coinbase_address_wallet_address.WalletAddress.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WalletAddress | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_address_wallet_address.html">coinbase/address/wallet_address</a></li><li><a href="coinbase_address_wallet_address.WalletAddress.html">WalletAddress</a></li></ul><h1>Class WalletAddress</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of a blockchain address, which is a wallet-controlled account on a network.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/address/wallet_address.WalletAddress">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a><ul class="tsd-hierarchy"><li><span class="target">WalletAddress</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L17">src/coinbase/address/wallet_address.ts:17</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_address_wallet_address.WalletAddress.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/address/wallet_address.WalletAddress">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a><ul class="tsd-hierarchy"><li><span class="target">WalletAddress</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L24">src/coinbase/address/wallet_address.ts:24</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_address_wallet_address.WalletAddress.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_address_wallet_address.WalletAddress.html#id" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a> <a href="coinbase_address_wallet_address.WalletAddress.html#key" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key?</span></a> <a href="coinbase_address_wallet_address.WalletAddress.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> @@ -25,60 +25,59 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">model</span>: <a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a></span><div class="tsd-comment tsd-typography"><p>The address model data.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">Wallet</span></span><div class="tsd-comment tsd-typography"><p>The ethers.js SigningKey the Address uses to sign data.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the address model is empty.</p> -</div><aside class="tsd-sources"><p>Overrides <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L28">src/coinbase/address/wallet_address.ts:28</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L13">src/coinbase/address.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>key</span><a href="#key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Wallet</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L19">src/coinbase/address/wallet_address.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L18">src/coinbase/address/wallet_address.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="networkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>network<wbr/>Id</span><a href="#networkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#networkId">networkId</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L12">src/coinbase/address.ts:12</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="broadcastTradeRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>broadcast<wbr/>Trade<wbr/>Request</span><a href="#broadcastTradeRequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="broadcastTradeRequest.broadcastTradeRequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">broadcast<wbr/>Trade<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">trade</span>, <span class="tsd-kind-parameter">signedPayload</span>, <span class="tsd-kind-parameter">approveTransactionPayload</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span><a href="#broadcastTradeRequest.broadcastTradeRequest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Broadcasts a trade using the provided signed payloads.</p> +</div><aside class="tsd-sources"><p>Overrides <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L35">src/coinbase/address/wallet_address.ts:35</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L13">src/coinbase/address.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>key</span><a href="#key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Wallet</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L26">src/coinbase/address/wallet_address.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L25">src/coinbase/address/wallet_address.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="networkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>network<wbr/>Id</span><a href="#networkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#networkId">networkId</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L12">src/coinbase/address.ts:12</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="broadcastTradeRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>broadcast<wbr/>Trade<wbr/>Request</span><a href="#broadcastTradeRequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="broadcastTradeRequest.broadcastTradeRequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">broadcast<wbr/>Trade<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">trade</span>, <span class="tsd-kind-parameter">signedPayload</span>, <span class="tsd-kind-parameter">approveTransactionPayload</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span><a href="#broadcastTradeRequest.broadcastTradeRequest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Broadcasts a trade using the provided signed payloads.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">trade</span>: <a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a></span><div class="tsd-comment tsd-typography"><p>The Trade object representing the trade.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">signedPayload</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The signed payload of the trade.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">approveTransactionPayload</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The signed payload of the approval transaction, if any.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves to a Trade object representing the broadcasted trade.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L302">src/coinbase/address/wallet_address.ts:302</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="canSign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>can<wbr/>Sign</span><a href="#canSign" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="canSign.canSign-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">can<wbr/>Sign</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#canSign.canSign-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether the Address has a private key backing it to sign transactions.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L336">src/coinbase/address/wallet_address.ts:336</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="canSign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>can<wbr/>Sign</span><a href="#canSign" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="canSign.canSign-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">can<wbr/>Sign</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#canSign.canSign-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether the Address has a private key backing it to sign transactions.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the Address has a private key backing it to sign transactions.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L240">src/coinbase/address/wallet_address.ts:240</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Trade</span><a href="#createTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">fromAssetId</span>, <span class="tsd-kind-parameter">toAssetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span><a href="#createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Trades the given amount of the given Asset for another Asset. Only same-network Trades are supported.</p> -</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">amount</span>: <a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></span><div class="tsd-comment tsd-typography"><p>The amount of the Asset to send.</p> -</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fromAssetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the Asset to trade from.</p> -</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">toAssetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the Asset to trade to.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L247">src/coinbase/address/wallet_address.ts:247</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Trade</span><a href="#createTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span><a href="#createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Trades the given amount of the given Asset for another Asset. Only same-network Trades are supported.</p> +</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/coinbase_types.CreateTradeOptions.html" class="tsd-signature-type tsd-kind-type-alias">CreateTradeOptions</a></span><div class="tsd-comment tsd-typography"><p>= The options to create the Trade.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span></h4><p>The Trade object.</p> -<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the private key is not loaded, or if the asset IDs are unsupported, or if there are insufficient funds.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L253">src/coinbase/address/wallet_address.ts:253</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="createTradeRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>create<wbr/>Trade<wbr/>Request</span><a href="#createTradeRequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="createTradeRequest.createTradeRequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">fromAsset</span>, <span class="tsd-kind-parameter">toAsset</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span><a href="#createTradeRequest.createTradeRequest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a trade model for the specified amount and assets.</p> +<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>if the API request to create or broadcast a Trade fails.</p> +<h4>Throws</h4><p>if the Trade times out.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L264">src/coinbase/address/wallet_address.ts:264</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="createTradeRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>create<wbr/>Trade<wbr/>Request</span><a href="#createTradeRequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="createTradeRequest.createTradeRequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">fromAsset</span>, <span class="tsd-kind-parameter">toAsset</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span><a href="#createTradeRequest.createTradeRequest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a trade model for the specified amount and assets.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">amount</span>: <a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></span><div class="tsd-comment tsd-typography"><p>The amount of the Asset to send.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fromAsset</span>: <a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a></span><div class="tsd-comment tsd-typography"><p>The Asset to trade from.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">toAsset</span>: <a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a></span><div class="tsd-comment tsd-typography"><p>The Asset to trade to.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves to a Trade object representing the new trade.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L276">src/coinbase/address/wallet_address.ts:276</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Transfer</span><a href="#createTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_transfer.Transfer.html" class="tsd-signature-type tsd-kind-class">Transfer</a><span class="tsd-signature-symbol">></span><a href="#createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Transfers the given amount of the given Asset to the given address. Only same-Network Transfers are supported.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L310">src/coinbase/address/wallet_address.ts:310</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Transfer</span><a href="#createTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_transfer.Transfer.html" class="tsd-signature-type tsd-kind-class">Transfer</a><span class="tsd-signature-symbol">></span><a href="#createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Transfers the given amount of the given Asset to the given address. Only same-Network Transfers are supported.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/coinbase_types.CreateTransferOptions.html" class="tsd-signature-type tsd-kind-type-alias">CreateTransferOptions</a></span><div class="tsd-comment tsd-typography"><p>The options to create the Transfer.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_transfer.Transfer.html" class="tsd-signature-type tsd-kind-class">Transfer</a><span class="tsd-signature-symbol">></span></h4><p>The transfer object.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>if the API request to create a Transfer fails.</p> <h4>Throws</h4><p>if the API request to broadcast a Transfer fails.</p> <h4>Throws</h4><p>if the Transfer times out.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L147">src/coinbase/address/wallet_address.ts:147</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="faucet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>faucet</span><a href="#faucet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="faucet.faucet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">faucet</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#faucet.faucet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests faucet funds for the address. +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L154">src/coinbase/address/wallet_address.ts:154</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="faucet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>faucet</span><a href="#faucet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="faucet.faucet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">faucet</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#faucet.faucet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests faucet funds for the address. Only supported on testnet networks.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a><span class="tsd-signature-symbol">></span></h4><p>The faucet transaction object.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request does not return a transaction hash.</p> <h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#faucet">faucet</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L86">src/coinbase/address.ts:86</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Balance</span><a href="#getBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getBalance.getBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#getBalance.getBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the balance of the provided asset.</p> +</div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#faucet">faucet</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L86">src/coinbase/address.ts:86</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Balance</span><a href="#getBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getBalance.getBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#getBalance.getBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the balance of the provided asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset ID.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span></h4><p>The balance of the asset.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#getBalance">getBalance</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L64">src/coinbase/address.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getDestinationAddressAndNetwork" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Destination<wbr/>Address<wbr/>And<wbr/>Network</span><a href="#getDestinationAddressAndNetwork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getDestinationAddressAndNetwork.getDestinationAddressAndNetwork-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Destination<wbr/>Address<wbr/>And<wbr/>Network</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">destination</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><a href="#getDestinationAddressAndNetwork.getDestinationAddressAndNetwork-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the address and network ID of the given destination.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#getBalance">getBalance</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L64">src/coinbase/address.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getDestinationAddressAndNetwork" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Destination<wbr/>Address<wbr/>And<wbr/>Network</span><a href="#getDestinationAddressAndNetwork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getDestinationAddressAndNetwork.getDestinationAddressAndNetwork-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Destination<wbr/>Address<wbr/>And<wbr/>Network</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">destination</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><a href="#getDestinationAddressAndNetwork.getDestinationAddressAndNetwork-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the address and network ID of the given destination.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">destination</span>: <a href="../types/coinbase_types.Destination.html" class="tsd-signature-type tsd-kind-type-alias">Destination</a></span><div class="tsd-comment tsd-typography"><p>The destination to get the address and network ID of.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></h4><p>The address and network ID of the destination.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L222">src/coinbase/address/wallet_address.ts:222</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the address ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L229">src/coinbase/address/wallet_address.ts:229</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the address ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The address ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#getId">getId</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L40">src/coinbase/address.ts:40</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getNetworkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Network<wbr/>Id</span><a href="#getNetworkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getNetworkId.getNetworkId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Network<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getNetworkId.getNetworkId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the network ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#getId">getId</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L40">src/coinbase/address.ts:40</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getNetworkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Network<wbr/>Id</span><a href="#getNetworkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getNetworkId.getNetworkId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Network<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getNetworkId.getNetworkId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the network ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The network ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#getNetworkId">getNetworkId</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L31">src/coinbase/address.ts:31</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWalletId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet<wbr/>Id</span><a href="#getWalletId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWalletId.getWalletId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getWalletId.getWalletId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the wallet ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#getNetworkId">getNetworkId</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L31">src/coinbase/address.ts:31</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWalletId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet<wbr/>Id</span><a href="#getWalletId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWalletId.getWalletId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getWalletId.getWalletId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the wallet ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The wallet ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L52">src/coinbase/address/wallet_address.ts:52</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="listBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Balances</span><a href="#listBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="listBalances.listBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><span class="tsd-signature-symbol">></span><a href="#listBalances.listBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of balances for the address.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L59">src/coinbase/address/wallet_address.ts:59</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="listBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Balances</span><a href="#listBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="listBalances.listBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><span class="tsd-signature-symbol">></span><a href="#listBalances.listBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of balances for the address.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><span class="tsd-signature-symbol">></span></h4><p>The map from asset ID to balance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#listBalances">listBalances</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L49">src/coinbase/address.ts:49</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTrades" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Trades</span><a href="#listTrades" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTrades.listTrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Trades</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listTrades.listTrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns all the transfers associated with the address.</p> -</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The list of transfers.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L74">src/coinbase/address/wallet_address.ts:74</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTransfers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Transfers</span><a href="#listTransfers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTransfers.listTransfers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Transfers</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_transfer.Transfer.html" class="tsd-signature-type tsd-kind-class">Transfer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listTransfers.listTransfers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns all the transfers associated with the address.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#listBalances">listBalances</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L49">src/coinbase/address.ts:49</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTrades" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Trades</span><a href="#listTrades" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTrades.listTrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Trades</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listTrades.listTrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns all the trades associated with the address.</p> +</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The list of trades.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L81">src/coinbase/address/wallet_address.ts:81</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTransfers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Transfers</span><a href="#listTransfers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTransfers.listTransfers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Transfers</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_transfer.Transfer.html" class="tsd-signature-type tsd-kind-class">Transfer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listTransfers.listTransfers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns all the transfers associated with the address.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_transfer.Transfer.html" class="tsd-signature-type tsd-kind-class">Transfer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The list of transfers.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L106">src/coinbase/address/wallet_address.ts:106</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Key</span><a href="#setKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setKey.setKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setKey.setKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the private key.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L113">src/coinbase/address/wallet_address.ts:113</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Key</span><a href="#setKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setKey.setKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setKey.setKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the private key.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">Wallet</span></span><div class="tsd-comment tsd-typography"><p>The ethers.js SigningKey the Address uses to sign data.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the private key is already set.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L62">src/coinbase/address/wallet_address.ts:62</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the wallet address.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L69">src/coinbase/address/wallet_address.ts:69</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the wallet address.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A string representing the wallet address.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L43">src/coinbase/address/wallet_address.ts:43</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="validateCanTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Can<wbr/>Trade</span><a href="#validateCanTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="validateCanTrade.validateCanTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Can<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">fromAssetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#validateCanTrade.validateCanTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if trading is possible and raises an error if not.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="coinbase_address.Address.html">Address</a>.<a href="coinbase_address.Address.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L50">src/coinbase/address/wallet_address.ts:50</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="validateCanTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Can<wbr/>Trade</span><a href="#validateCanTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="validateCanTrade.validateCanTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Can<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">fromAssetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#validateCanTrade.validateCanTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if trading is possible and raises an error if not.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">amount</span>: <a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></span><div class="tsd-comment tsd-typography"><p>The amount of the Asset to send.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fromAssetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the Asset to trade from. For Ether, eth, gwei, and wei are supported.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the private key is not loaded, or if the asset IDs are unsupported, or if there are insufficient funds.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L331">src/coinbase/address/wallet_address.ts:331</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#key" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#networkId" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a><a href="#broadcastTradeRequest" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Trade<wbr/>Request</span></a><a href="#canSign" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Sign</span></a><a href="#createTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Trade</span></a><a href="#createTradeRequest" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Trade<wbr/>Request</span></a><a href="#createTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Transfer</span></a><a href="#faucet" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>faucet</span></a><a href="#getBalance" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Balance</span></a><a href="#getDestinationAddressAndNetwork" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Destination<wbr/>Address<wbr/>And<wbr/>Network</span></a><a href="#getId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getNetworkId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Network<wbr/>Id</span></a><a href="#getWalletId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet<wbr/>Id</span></a><a href="#listBalances" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Balances</span></a><a href="#listTrades" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Trades</span></a><a href="#listTransfers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Transfers</span></a><a href="#setKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Key</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#validateCanTrade" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Can<wbr/>Trade</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L365">src/coinbase/address/wallet_address.ts:365</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#key" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#networkId" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a><a href="#broadcastTradeRequest" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Trade<wbr/>Request</span></a><a href="#canSign" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Sign</span></a><a href="#createTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Trade</span></a><a href="#createTradeRequest" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Trade<wbr/>Request</span></a><a href="#createTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Transfer</span></a><a href="#faucet" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>faucet</span></a><a href="#getBalance" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Balance</span></a><a href="#getDestinationAddressAndNetwork" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Destination<wbr/>Address<wbr/>And<wbr/>Network</span></a><a href="#getId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getNetworkId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Network<wbr/>Id</span></a><a href="#getWalletId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet<wbr/>Id</span></a><a href="#listBalances" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Balances</span></a><a href="#listTrades" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Trades</span></a><a href="#listTransfers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Transfers</span></a><a href="#setKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Key</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#validateCanTrade" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Can<wbr/>Trade</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.APIError.html b/docs/classes/coinbase_api_error.APIError.html index 104c5c25..5724ee49 100644 --- a/docs/classes/coinbase_api_error.APIError.html +++ b/docs/classes/coinbase_api_error.APIError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>APIError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.APIError.html">APIError</a></li></ul><h1>Class APIError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.APIError">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">AxiosError</span><ul class="tsd-hierarchy"><li><span class="target">APIError</span><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.UnimplementedError.html" class="tsd-signature-type tsd-kind-class">UnimplementedError</a></li><li><a href="coinbase_api_error.UnauthorizedError.html" class="tsd-signature-type tsd-kind-class">UnauthorizedError</a></li><li><a href="coinbase_api_error.NotFoundError.html" class="tsd-signature-type tsd-kind-class">NotFoundError</a></li><li><a href="coinbase_api_error.InvalidWalletIDError.html" class="tsd-signature-type tsd-kind-class">InvalidWalletIDError</a></li><li><a href="coinbase_api_error.InvalidAddressIDError.html" class="tsd-signature-type tsd-kind-class">InvalidAddressIDError</a></li><li><a href="coinbase_api_error.InvalidWalletError.html" class="tsd-signature-type tsd-kind-class">InvalidWalletError</a></li><li><a href="coinbase_api_error.InvalidAddressError.html" class="tsd-signature-type tsd-kind-class">InvalidAddressError</a></li><li><a href="coinbase_api_error.InvalidAmountError.html" class="tsd-signature-type tsd-kind-class">InvalidAmountError</a></li><li><a href="coinbase_api_error.InvalidTransferIDError.html" class="tsd-signature-type tsd-kind-class">InvalidTransferIDError</a></li><li><a href="coinbase_api_error.InvalidPageError.html" class="tsd-signature-type tsd-kind-class">InvalidPageError</a></li><li><a href="coinbase_api_error.InvalidLimitError.html" class="tsd-signature-type tsd-kind-class">InvalidLimitError</a></li><li><a href="coinbase_api_error.AlreadyExistsError.html" class="tsd-signature-type tsd-kind-class">AlreadyExistsError</a></li><li><a href="coinbase_api_error.MalformedRequestError.html" class="tsd-signature-type tsd-kind-class">MalformedRequestError</a></li><li><a href="coinbase_api_error.UnsupportedAssetError.html" class="tsd-signature-type tsd-kind-class">UnsupportedAssetError</a></li><li><a href="coinbase_api_error.InvalidAssetIDError.html" class="tsd-signature-type tsd-kind-class">InvalidAssetIDError</a></li><li><a href="coinbase_api_error.InvalidDestinationError.html" class="tsd-signature-type tsd-kind-class">InvalidDestinationError</a></li><li><a href="coinbase_api_error.InvalidNetworkIDError.html" class="tsd-signature-type tsd-kind-class">InvalidNetworkIDError</a></li><li><a href="coinbase_api_error.ResourceExhaustedError.html" class="tsd-signature-type tsd-kind-class">ResourceExhaustedError</a></li><li><a href="coinbase_api_error.FaucetLimitReachedError.html" class="tsd-signature-type tsd-kind-class">FaucetLimitReachedError</a></li><li><a href="coinbase_api_error.InvalidSignedPayloadError.html" class="tsd-signature-type tsd-kind-class">InvalidSignedPayloadError</a></li><li><a href="coinbase_api_error.InvalidTransferStatusError.html" class="tsd-signature-type tsd-kind-class">InvalidTransferStatusError</a></li><li><a href="coinbase_api_error.NetworkFeatureUnsupportedError.html" class="tsd-signature-type tsd-kind-class">NetworkFeatureUnsupportedError</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L16">src/coinbase/api_error.ts:16</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.APIError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.APIError">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">AxiosError</span><ul class="tsd-hierarchy"><li><span class="target">APIError</span><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.UnimplementedError.html" class="tsd-signature-type tsd-kind-class">UnimplementedError</a></li><li><a href="coinbase_api_error.UnauthorizedError.html" class="tsd-signature-type tsd-kind-class">UnauthorizedError</a></li><li><a href="coinbase_api_error.NotFoundError.html" class="tsd-signature-type tsd-kind-class">NotFoundError</a></li><li><a href="coinbase_api_error.InvalidWalletIDError.html" class="tsd-signature-type tsd-kind-class">InvalidWalletIDError</a></li><li><a href="coinbase_api_error.InvalidAddressIDError.html" class="tsd-signature-type tsd-kind-class">InvalidAddressIDError</a></li><li><a href="coinbase_api_error.InvalidWalletError.html" class="tsd-signature-type tsd-kind-class">InvalidWalletError</a></li><li><a href="coinbase_api_error.InvalidAddressError.html" class="tsd-signature-type tsd-kind-class">InvalidAddressError</a></li><li><a href="coinbase_api_error.InvalidAmountError.html" class="tsd-signature-type tsd-kind-class">InvalidAmountError</a></li><li><a href="coinbase_api_error.InvalidTransferIDError.html" class="tsd-signature-type tsd-kind-class">InvalidTransferIDError</a></li><li><a href="coinbase_api_error.InvalidPageError.html" class="tsd-signature-type tsd-kind-class">InvalidPageError</a></li><li><a href="coinbase_api_error.InvalidLimitError.html" class="tsd-signature-type tsd-kind-class">InvalidLimitError</a></li><li><a href="coinbase_api_error.AlreadyExistsError.html" class="tsd-signature-type tsd-kind-class">AlreadyExistsError</a></li><li><a href="coinbase_api_error.MalformedRequestError.html" class="tsd-signature-type tsd-kind-class">MalformedRequestError</a></li><li><a href="coinbase_api_error.UnsupportedAssetError.html" class="tsd-signature-type tsd-kind-class">UnsupportedAssetError</a></li><li><a href="coinbase_api_error.InvalidAssetIDError.html" class="tsd-signature-type tsd-kind-class">InvalidAssetIDError</a></li><li><a href="coinbase_api_error.InvalidDestinationError.html" class="tsd-signature-type tsd-kind-class">InvalidDestinationError</a></li><li><a href="coinbase_api_error.InvalidNetworkIDError.html" class="tsd-signature-type tsd-kind-class">InvalidNetworkIDError</a></li><li><a href="coinbase_api_error.ResourceExhaustedError.html" class="tsd-signature-type tsd-kind-class">ResourceExhaustedError</a></li><li><a href="coinbase_api_error.FaucetLimitReachedError.html" class="tsd-signature-type tsd-kind-class">FaucetLimitReachedError</a></li><li><a href="coinbase_api_error.InvalidSignedPayloadError.html" class="tsd-signature-type tsd-kind-class">InvalidSignedPayloadError</a></li><li><a href="coinbase_api_error.InvalidTransferStatusError.html" class="tsd-signature-type tsd-kind-class">InvalidTransferStatusError</a></li><li><a href="coinbase_api_error.NetworkFeatureUnsupportedError.html" class="tsd-signature-type tsd-kind-class">NetworkFeatureUnsupportedError</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L16">src/coinbase/api_error.ts:16</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.APIError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.APIError.html#apiCode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.APIError.html#apiMessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.APIError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.APIError.html#fromError" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_APIError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new APIError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#constructor.new_APIError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides AxiosError.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.cause</p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.code</p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from AxiosError.config</p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.isAxiosError</p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.request</p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from AxiosError.response</p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.status</p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from AxiosError.toJSON</p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ECONNABORTED</p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_BAD_OPTION</p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_BAD_OPTION_VALUE</p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_BAD_REQUEST</p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_BAD_RESPONSE</p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_CANCELED</p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_DEPRECATED</p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_FR_TOO_MANY_REDIRECTS</p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_INVALID_URL</p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_NETWORK</p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_NOT_SUPPORT</p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ETIMEDOUT</p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides AxiosError.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.cause</p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.code</p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from AxiosError.config</p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.isAxiosError</p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.request</p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from AxiosError.response</p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.status</p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from AxiosError.toJSON</p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ECONNABORTED</p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_BAD_OPTION</p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_BAD_OPTION_VALUE</p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_BAD_REQUEST</p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_BAD_RESPONSE</p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_CANCELED</p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_DEPRECATED</p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_FR_TOO_MANY_REDIRECTS</p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_INVALID_URL</p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_NETWORK</p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ERR_NOT_SUPPORT</p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.ETIMEDOUT</p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from AxiosError.prepareStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from AxiosError.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from AxiosError.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from AxiosError.from</p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.AlreadyExistsError.html b/docs/classes/coinbase_api_error.AlreadyExistsError.html index 4c5f83d6..21c92a95 100644 --- a/docs/classes/coinbase_api_error.AlreadyExistsError.html +++ b/docs/classes/coinbase_api_error.AlreadyExistsError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AlreadyExistsError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.AlreadyExistsError.html">AlreadyExistsError</a></li></ul><h1>Class AlreadyExistsError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.AlreadyExistsError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">AlreadyExistsError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L127">src/coinbase/api_error.ts:127</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.AlreadyExistsError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.AlreadyExistsError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">AlreadyExistsError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L127">src/coinbase/api_error.ts:127</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.AlreadyExistsError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.AlreadyExistsError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.AlreadyExistsError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.AlreadyExistsError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.AlreadyExistsError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_AlreadyExistsError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Already<wbr/>Exists<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.AlreadyExistsError.html" class="tsd-signature-type tsd-kind-class">AlreadyExistsError</a><a href="#constructor.new_AlreadyExistsError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.AlreadyExistsError.html" class="tsd-signature-type tsd-kind-class">AlreadyExistsError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.AlreadyExistsError.html" class="tsd-signature-type tsd-kind-class">AlreadyExistsError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.AlreadyExistsError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.AlreadyExistsError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.FaucetLimitReachedError.html b/docs/classes/coinbase_api_error.FaucetLimitReachedError.html index 7d9e93ce..80c8e88a 100644 --- a/docs/classes/coinbase_api_error.FaucetLimitReachedError.html +++ b/docs/classes/coinbase_api_error.FaucetLimitReachedError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FaucetLimitReachedError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.FaucetLimitReachedError.html">FaucetLimitReachedError</a></li></ul><h1>Class FaucetLimitReachedError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.FaucetLimitReachedError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">FaucetLimitReachedError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L134">src/coinbase/api_error.ts:134</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.FaucetLimitReachedError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.FaucetLimitReachedError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">FaucetLimitReachedError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L134">src/coinbase/api_error.ts:134</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.FaucetLimitReachedError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.FaucetLimitReachedError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.FaucetLimitReachedError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.FaucetLimitReachedError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.FaucetLimitReachedError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_FaucetLimitReachedError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Faucet<wbr/>Limit<wbr/>Reached<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.FaucetLimitReachedError.html" class="tsd-signature-type tsd-kind-class">FaucetLimitReachedError</a><a href="#constructor.new_FaucetLimitReachedError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.FaucetLimitReachedError.html" class="tsd-signature-type tsd-kind-class">FaucetLimitReachedError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.FaucetLimitReachedError.html" class="tsd-signature-type tsd-kind-class">FaucetLimitReachedError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.FaucetLimitReachedError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.FaucetLimitReachedError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidAddressError.html b/docs/classes/coinbase_api_error.InvalidAddressError.html index 0ddf8037..50cdd8f1 100644 --- a/docs/classes/coinbase_api_error.InvalidAddressError.html +++ b/docs/classes/coinbase_api_error.InvalidAddressError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidAddressError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidAddressError.html">InvalidAddressError</a></li></ul><h1>Class InvalidAddressError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidAddressError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidAddressError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L122">src/coinbase/api_error.ts:122</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidAddressError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidAddressError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidAddressError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L122">src/coinbase/api_error.ts:122</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidAddressError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidAddressError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidAddressError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidAddressError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidAddressError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidAddressError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>Address<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidAddressError.html" class="tsd-signature-type tsd-kind-class">InvalidAddressError</a><a href="#constructor.new_InvalidAddressError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidAddressError.html" class="tsd-signature-type tsd-kind-class">InvalidAddressError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidAddressError.html" class="tsd-signature-type tsd-kind-class">InvalidAddressError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidAddressError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidAddressError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidAddressIDError.html b/docs/classes/coinbase_api_error.InvalidAddressIDError.html index c715888f..ec19a4a7 100644 --- a/docs/classes/coinbase_api_error.InvalidAddressIDError.html +++ b/docs/classes/coinbase_api_error.InvalidAddressIDError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidAddressIDError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidAddressIDError.html">InvalidAddressIDError</a></li></ul><h1>Class InvalidAddressIDError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidAddressIDError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidAddressIDError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L120">src/coinbase/api_error.ts:120</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidAddressIDError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidAddressIDError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidAddressIDError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L120">src/coinbase/api_error.ts:120</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidAddressIDError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidAddressIDError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidAddressIDError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidAddressIDError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidAddressIDError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidAddressIDError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>AddressIDError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidAddressIDError.html" class="tsd-signature-type tsd-kind-class">InvalidAddressIDError</a><a href="#constructor.new_InvalidAddressIDError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidAddressIDError.html" class="tsd-signature-type tsd-kind-class">InvalidAddressIDError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidAddressIDError.html" class="tsd-signature-type tsd-kind-class">InvalidAddressIDError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidAddressIDError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidAddressIDError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidAmountError.html b/docs/classes/coinbase_api_error.InvalidAmountError.html index ab15d57f..e0d4719c 100644 --- a/docs/classes/coinbase_api_error.InvalidAmountError.html +++ b/docs/classes/coinbase_api_error.InvalidAmountError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidAmountError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidAmountError.html">InvalidAmountError</a></li></ul><h1>Class InvalidAmountError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidAmountError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidAmountError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L123">src/coinbase/api_error.ts:123</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidAmountError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidAmountError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidAmountError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L123">src/coinbase/api_error.ts:123</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidAmountError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidAmountError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidAmountError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidAmountError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidAmountError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidAmountError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>Amount<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidAmountError.html" class="tsd-signature-type tsd-kind-class">InvalidAmountError</a><a href="#constructor.new_InvalidAmountError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidAmountError.html" class="tsd-signature-type tsd-kind-class">InvalidAmountError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidAmountError.html" class="tsd-signature-type tsd-kind-class">InvalidAmountError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidAmountError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidAmountError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidAssetIDError.html b/docs/classes/coinbase_api_error.InvalidAssetIDError.html index 002967eb..77aca50e 100644 --- a/docs/classes/coinbase_api_error.InvalidAssetIDError.html +++ b/docs/classes/coinbase_api_error.InvalidAssetIDError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidAssetIDError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidAssetIDError.html">InvalidAssetIDError</a></li></ul><h1>Class InvalidAssetIDError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidAssetIDError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidAssetIDError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L130">src/coinbase/api_error.ts:130</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidAssetIDError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidAssetIDError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidAssetIDError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L130">src/coinbase/api_error.ts:130</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidAssetIDError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidAssetIDError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidAssetIDError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidAssetIDError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidAssetIDError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidAssetIDError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>AssetIDError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidAssetIDError.html" class="tsd-signature-type tsd-kind-class">InvalidAssetIDError</a><a href="#constructor.new_InvalidAssetIDError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidAssetIDError.html" class="tsd-signature-type tsd-kind-class">InvalidAssetIDError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidAssetIDError.html" class="tsd-signature-type tsd-kind-class">InvalidAssetIDError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidAssetIDError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidAssetIDError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidDestinationError.html b/docs/classes/coinbase_api_error.InvalidDestinationError.html index 3e5cf3fe..b8e66d88 100644 --- a/docs/classes/coinbase_api_error.InvalidDestinationError.html +++ b/docs/classes/coinbase_api_error.InvalidDestinationError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidDestinationError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidDestinationError.html">InvalidDestinationError</a></li></ul><h1>Class InvalidDestinationError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidDestinationError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidDestinationError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L131">src/coinbase/api_error.ts:131</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidDestinationError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidDestinationError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidDestinationError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L131">src/coinbase/api_error.ts:131</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidDestinationError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidDestinationError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidDestinationError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidDestinationError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidDestinationError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidDestinationError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>Destination<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidDestinationError.html" class="tsd-signature-type tsd-kind-class">InvalidDestinationError</a><a href="#constructor.new_InvalidDestinationError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidDestinationError.html" class="tsd-signature-type tsd-kind-class">InvalidDestinationError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidDestinationError.html" class="tsd-signature-type tsd-kind-class">InvalidDestinationError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidDestinationError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidDestinationError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidLimitError.html b/docs/classes/coinbase_api_error.InvalidLimitError.html index 11c6ed97..5f058ca8 100644 --- a/docs/classes/coinbase_api_error.InvalidLimitError.html +++ b/docs/classes/coinbase_api_error.InvalidLimitError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidLimitError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidLimitError.html">InvalidLimitError</a></li></ul><h1>Class InvalidLimitError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidLimitError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidLimitError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L126">src/coinbase/api_error.ts:126</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidLimitError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidLimitError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidLimitError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L126">src/coinbase/api_error.ts:126</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidLimitError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidLimitError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidLimitError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidLimitError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidLimitError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidLimitError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>Limit<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidLimitError.html" class="tsd-signature-type tsd-kind-class">InvalidLimitError</a><a href="#constructor.new_InvalidLimitError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidLimitError.html" class="tsd-signature-type tsd-kind-class">InvalidLimitError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidLimitError.html" class="tsd-signature-type tsd-kind-class">InvalidLimitError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidLimitError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidLimitError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidNetworkIDError.html b/docs/classes/coinbase_api_error.InvalidNetworkIDError.html index 2e5ae45d..2de878b8 100644 --- a/docs/classes/coinbase_api_error.InvalidNetworkIDError.html +++ b/docs/classes/coinbase_api_error.InvalidNetworkIDError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidNetworkIDError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidNetworkIDError.html">InvalidNetworkIDError</a></li></ul><h1>Class InvalidNetworkIDError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidNetworkIDError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidNetworkIDError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L132">src/coinbase/api_error.ts:132</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidNetworkIDError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidNetworkIDError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidNetworkIDError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L132">src/coinbase/api_error.ts:132</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidNetworkIDError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidNetworkIDError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidNetworkIDError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidNetworkIDError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidNetworkIDError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidNetworkIDError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>NetworkIDError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidNetworkIDError.html" class="tsd-signature-type tsd-kind-class">InvalidNetworkIDError</a><a href="#constructor.new_InvalidNetworkIDError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidNetworkIDError.html" class="tsd-signature-type tsd-kind-class">InvalidNetworkIDError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidNetworkIDError.html" class="tsd-signature-type tsd-kind-class">InvalidNetworkIDError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidNetworkIDError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidNetworkIDError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidPageError.html b/docs/classes/coinbase_api_error.InvalidPageError.html index 388be09c..1c6bc39e 100644 --- a/docs/classes/coinbase_api_error.InvalidPageError.html +++ b/docs/classes/coinbase_api_error.InvalidPageError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidPageError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidPageError.html">InvalidPageError</a></li></ul><h1>Class InvalidPageError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidPageError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidPageError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L125">src/coinbase/api_error.ts:125</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidPageError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidPageError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidPageError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L125">src/coinbase/api_error.ts:125</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidPageError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidPageError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidPageError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidPageError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidPageError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidPageError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>Page<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidPageError.html" class="tsd-signature-type tsd-kind-class">InvalidPageError</a><a href="#constructor.new_InvalidPageError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidPageError.html" class="tsd-signature-type tsd-kind-class">InvalidPageError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidPageError.html" class="tsd-signature-type tsd-kind-class">InvalidPageError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidPageError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidPageError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidSignedPayloadError.html b/docs/classes/coinbase_api_error.InvalidSignedPayloadError.html index 99994582..7cb56a6b 100644 --- a/docs/classes/coinbase_api_error.InvalidSignedPayloadError.html +++ b/docs/classes/coinbase_api_error.InvalidSignedPayloadError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidSignedPayloadError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidSignedPayloadError.html">InvalidSignedPayloadError</a></li></ul><h1>Class InvalidSignedPayloadError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidSignedPayloadError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidSignedPayloadError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L135">src/coinbase/api_error.ts:135</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidSignedPayloadError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidSignedPayloadError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidSignedPayloadError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L135">src/coinbase/api_error.ts:135</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidSignedPayloadError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidSignedPayloadError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidSignedPayloadError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidSignedPayloadError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidSignedPayloadError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidSignedPayloadError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>Signed<wbr/>Payload<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidSignedPayloadError.html" class="tsd-signature-type tsd-kind-class">InvalidSignedPayloadError</a><a href="#constructor.new_InvalidSignedPayloadError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidSignedPayloadError.html" class="tsd-signature-type tsd-kind-class">InvalidSignedPayloadError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidSignedPayloadError.html" class="tsd-signature-type tsd-kind-class">InvalidSignedPayloadError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidSignedPayloadError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidSignedPayloadError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidTransferIDError.html b/docs/classes/coinbase_api_error.InvalidTransferIDError.html index 3d0b87fc..9cd0109b 100644 --- a/docs/classes/coinbase_api_error.InvalidTransferIDError.html +++ b/docs/classes/coinbase_api_error.InvalidTransferIDError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidTransferIDError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidTransferIDError.html">InvalidTransferIDError</a></li></ul><h1>Class InvalidTransferIDError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidTransferIDError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidTransferIDError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L124">src/coinbase/api_error.ts:124</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidTransferIDError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidTransferIDError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidTransferIDError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L124">src/coinbase/api_error.ts:124</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidTransferIDError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidTransferIDError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidTransferIDError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidTransferIDError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidTransferIDError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidTransferIDError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>TransferIDError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidTransferIDError.html" class="tsd-signature-type tsd-kind-class">InvalidTransferIDError</a><a href="#constructor.new_InvalidTransferIDError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidTransferIDError.html" class="tsd-signature-type tsd-kind-class">InvalidTransferIDError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidTransferIDError.html" class="tsd-signature-type tsd-kind-class">InvalidTransferIDError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidTransferIDError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidTransferIDError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidTransferStatusError.html b/docs/classes/coinbase_api_error.InvalidTransferStatusError.html index 66a19326..b4980947 100644 --- a/docs/classes/coinbase_api_error.InvalidTransferStatusError.html +++ b/docs/classes/coinbase_api_error.InvalidTransferStatusError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidTransferStatusError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidTransferStatusError.html">InvalidTransferStatusError</a></li></ul><h1>Class InvalidTransferStatusError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidTransferStatusError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidTransferStatusError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L136">src/coinbase/api_error.ts:136</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidTransferStatusError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidTransferStatusError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidTransferStatusError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L136">src/coinbase/api_error.ts:136</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidTransferStatusError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidTransferStatusError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidTransferStatusError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidTransferStatusError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidTransferStatusError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidTransferStatusError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>Transfer<wbr/>Status<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidTransferStatusError.html" class="tsd-signature-type tsd-kind-class">InvalidTransferStatusError</a><a href="#constructor.new_InvalidTransferStatusError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidTransferStatusError.html" class="tsd-signature-type tsd-kind-class">InvalidTransferStatusError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidTransferStatusError.html" class="tsd-signature-type tsd-kind-class">InvalidTransferStatusError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidTransferStatusError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidTransferStatusError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidWalletError.html b/docs/classes/coinbase_api_error.InvalidWalletError.html index 9ee94b67..784adfc8 100644 --- a/docs/classes/coinbase_api_error.InvalidWalletError.html +++ b/docs/classes/coinbase_api_error.InvalidWalletError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidWalletError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidWalletError.html">InvalidWalletError</a></li></ul><h1>Class InvalidWalletError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidWalletError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidWalletError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L121">src/coinbase/api_error.ts:121</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidWalletError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidWalletError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidWalletError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L121">src/coinbase/api_error.ts:121</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidWalletError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidWalletError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidWalletError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidWalletError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidWalletError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidWalletError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>Wallet<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidWalletError.html" class="tsd-signature-type tsd-kind-class">InvalidWalletError</a><a href="#constructor.new_InvalidWalletError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidWalletError.html" class="tsd-signature-type tsd-kind-class">InvalidWalletError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidWalletError.html" class="tsd-signature-type tsd-kind-class">InvalidWalletError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidWalletError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidWalletError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidWalletIDError.html b/docs/classes/coinbase_api_error.InvalidWalletIDError.html index 81a99cc5..2509f710 100644 --- a/docs/classes/coinbase_api_error.InvalidWalletIDError.html +++ b/docs/classes/coinbase_api_error.InvalidWalletIDError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidWalletIDError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.InvalidWalletIDError.html">InvalidWalletIDError</a></li></ul><h1>Class InvalidWalletIDError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidWalletIDError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidWalletIDError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L119">src/coinbase/api_error.ts:119</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidWalletIDError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.InvalidWalletIDError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">InvalidWalletIDError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L119">src/coinbase/api_error.ts:119</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidWalletIDError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.InvalidWalletIDError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.InvalidWalletIDError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.InvalidWalletIDError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.InvalidWalletIDError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidWalletIDError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>WalletIDError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.InvalidWalletIDError.html" class="tsd-signature-type tsd-kind-class">InvalidWalletIDError</a><a href="#constructor.new_InvalidWalletIDError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidWalletIDError.html" class="tsd-signature-type tsd-kind-class">InvalidWalletIDError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.InvalidWalletIDError.html" class="tsd-signature-type tsd-kind-class">InvalidWalletIDError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidWalletIDError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.InvalidWalletIDError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.MalformedRequestError.html b/docs/classes/coinbase_api_error.MalformedRequestError.html index b32ac75a..4aa897d0 100644 --- a/docs/classes/coinbase_api_error.MalformedRequestError.html +++ b/docs/classes/coinbase_api_error.MalformedRequestError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MalformedRequestError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.MalformedRequestError.html">MalformedRequestError</a></li></ul><h1>Class MalformedRequestError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.MalformedRequestError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">MalformedRequestError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L128">src/coinbase/api_error.ts:128</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.MalformedRequestError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.MalformedRequestError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">MalformedRequestError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L128">src/coinbase/api_error.ts:128</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.MalformedRequestError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.MalformedRequestError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.MalformedRequestError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.MalformedRequestError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.MalformedRequestError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_MalformedRequestError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Malformed<wbr/>Request<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.MalformedRequestError.html" class="tsd-signature-type tsd-kind-class">MalformedRequestError</a><a href="#constructor.new_MalformedRequestError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.MalformedRequestError.html" class="tsd-signature-type tsd-kind-class">MalformedRequestError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.MalformedRequestError.html" class="tsd-signature-type tsd-kind-class">MalformedRequestError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.MalformedRequestError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.MalformedRequestError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.NetworkFeatureUnsupportedError.html b/docs/classes/coinbase_api_error.NetworkFeatureUnsupportedError.html index e15cfa83..7fd852d0 100644 --- a/docs/classes/coinbase_api_error.NetworkFeatureUnsupportedError.html +++ b/docs/classes/coinbase_api_error.NetworkFeatureUnsupportedError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NetworkFeatureUnsupportedError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.NetworkFeatureUnsupportedError.html">NetworkFeatureUnsupportedError</a></li></ul><h1>Class NetworkFeatureUnsupportedError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.NetworkFeatureUnsupportedError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">NetworkFeatureUnsupportedError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L137">src/coinbase/api_error.ts:137</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.NetworkFeatureUnsupportedError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.NetworkFeatureUnsupportedError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">NetworkFeatureUnsupportedError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L137">src/coinbase/api_error.ts:137</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.NetworkFeatureUnsupportedError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.NetworkFeatureUnsupportedError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.NetworkFeatureUnsupportedError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.NetworkFeatureUnsupportedError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.NetworkFeatureUnsupportedError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_NetworkFeatureUnsupportedError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Network<wbr/>Feature<wbr/>Unsupported<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.NetworkFeatureUnsupportedError.html" class="tsd-signature-type tsd-kind-class">NetworkFeatureUnsupportedError</a><a href="#constructor.new_NetworkFeatureUnsupportedError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.NetworkFeatureUnsupportedError.html" class="tsd-signature-type tsd-kind-class">NetworkFeatureUnsupportedError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.NetworkFeatureUnsupportedError.html" class="tsd-signature-type tsd-kind-class">NetworkFeatureUnsupportedError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.NetworkFeatureUnsupportedError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.NetworkFeatureUnsupportedError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.NotFoundError.html b/docs/classes/coinbase_api_error.NotFoundError.html index 5fc897c9..75e73c0d 100644 --- a/docs/classes/coinbase_api_error.NotFoundError.html +++ b/docs/classes/coinbase_api_error.NotFoundError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NotFoundError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.NotFoundError.html">NotFoundError</a></li></ul><h1>Class NotFoundError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.NotFoundError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">NotFoundError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L118">src/coinbase/api_error.ts:118</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.NotFoundError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.NotFoundError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">NotFoundError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L118">src/coinbase/api_error.ts:118</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.NotFoundError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.NotFoundError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.NotFoundError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.NotFoundError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.NotFoundError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_NotFoundError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Not<wbr/>Found<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.NotFoundError.html" class="tsd-signature-type tsd-kind-class">NotFoundError</a><a href="#constructor.new_NotFoundError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.NotFoundError.html" class="tsd-signature-type tsd-kind-class">NotFoundError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.NotFoundError.html" class="tsd-signature-type tsd-kind-class">NotFoundError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.NotFoundError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.NotFoundError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.ResourceExhaustedError.html b/docs/classes/coinbase_api_error.ResourceExhaustedError.html index 38e9a769..7c0bcdd9 100644 --- a/docs/classes/coinbase_api_error.ResourceExhaustedError.html +++ b/docs/classes/coinbase_api_error.ResourceExhaustedError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ResourceExhaustedError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.ResourceExhaustedError.html">ResourceExhaustedError</a></li></ul><h1>Class ResourceExhaustedError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.ResourceExhaustedError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">ResourceExhaustedError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L133">src/coinbase/api_error.ts:133</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.ResourceExhaustedError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.ResourceExhaustedError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">ResourceExhaustedError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L133">src/coinbase/api_error.ts:133</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.ResourceExhaustedError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.ResourceExhaustedError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.ResourceExhaustedError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.ResourceExhaustedError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.ResourceExhaustedError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ResourceExhaustedError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Resource<wbr/>Exhausted<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.ResourceExhaustedError.html" class="tsd-signature-type tsd-kind-class">ResourceExhaustedError</a><a href="#constructor.new_ResourceExhaustedError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.ResourceExhaustedError.html" class="tsd-signature-type tsd-kind-class">ResourceExhaustedError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.ResourceExhaustedError.html" class="tsd-signature-type tsd-kind-class">ResourceExhaustedError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.ResourceExhaustedError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.ResourceExhaustedError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.UnauthorizedError.html b/docs/classes/coinbase_api_error.UnauthorizedError.html index 13d97b71..e9992221 100644 --- a/docs/classes/coinbase_api_error.UnauthorizedError.html +++ b/docs/classes/coinbase_api_error.UnauthorizedError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UnauthorizedError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.UnauthorizedError.html">UnauthorizedError</a></li></ul><h1>Class UnauthorizedError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.UnauthorizedError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">UnauthorizedError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L117">src/coinbase/api_error.ts:117</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.UnauthorizedError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.UnauthorizedError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">UnauthorizedError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L117">src/coinbase/api_error.ts:117</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.UnauthorizedError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.UnauthorizedError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.UnauthorizedError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.UnauthorizedError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.UnauthorizedError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_UnauthorizedError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Unauthorized<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.UnauthorizedError.html" class="tsd-signature-type tsd-kind-class">UnauthorizedError</a><a href="#constructor.new_UnauthorizedError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.UnauthorizedError.html" class="tsd-signature-type tsd-kind-class">UnauthorizedError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.UnauthorizedError.html" class="tsd-signature-type tsd-kind-class">UnauthorizedError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.UnauthorizedError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.UnauthorizedError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.UnimplementedError.html b/docs/classes/coinbase_api_error.UnimplementedError.html index e0af5c35..df5ccc52 100644 --- a/docs/classes/coinbase_api_error.UnimplementedError.html +++ b/docs/classes/coinbase_api_error.UnimplementedError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UnimplementedError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.UnimplementedError.html">UnimplementedError</a></li></ul><h1>Class UnimplementedError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.UnimplementedError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">UnimplementedError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L116">src/coinbase/api_error.ts:116</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.UnimplementedError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.UnimplementedError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">UnimplementedError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L116">src/coinbase/api_error.ts:116</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.UnimplementedError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.UnimplementedError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.UnimplementedError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.UnimplementedError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.UnimplementedError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_UnimplementedError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Unimplemented<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.UnimplementedError.html" class="tsd-signature-type tsd-kind-class">UnimplementedError</a><a href="#constructor.new_UnimplementedError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.UnimplementedError.html" class="tsd-signature-type tsd-kind-class">UnimplementedError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.UnimplementedError.html" class="tsd-signature-type tsd-kind-class">UnimplementedError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.UnimplementedError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.UnimplementedError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_api_error.UnsupportedAssetError.html b/docs/classes/coinbase_api_error.UnsupportedAssetError.html index d0e439fb..25f206c6 100644 --- a/docs/classes/coinbase_api_error.UnsupportedAssetError.html +++ b/docs/classes/coinbase_api_error.UnsupportedAssetError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UnsupportedAssetError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_api_error.html">coinbase/api_error</a></li><li><a href="coinbase_api_error.UnsupportedAssetError.html">UnsupportedAssetError</a></li></ul><h1>Class UnsupportedAssetError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A wrapper for API errors to provide more context.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.UnsupportedAssetError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">UnsupportedAssetError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L129">src/coinbase/api_error.ts:129</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.UnsupportedAssetError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#coinbase/api_error.UnsupportedAssetError">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><ul class="tsd-hierarchy"><li><span class="target">UnsupportedAssetError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L129">src/coinbase/api_error.ts:129</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_api_error.UnsupportedAssetError.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_api_error.UnsupportedAssetError.html#apiCode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a> <a href="coinbase_api_error.UnsupportedAssetError.html#apiMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a> <a href="coinbase_api_error.UnsupportedAssetError.html#cause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause?</span></a> @@ -34,12 +34,12 @@ <a href="coinbase_api_error.UnsupportedAssetError.html#fromError" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_UnsupportedAssetError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Unsupported<wbr/>Asset<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_api_error.UnsupportedAssetError.html" class="tsd-signature-type tsd-kind-class">UnsupportedAssetError</a><a href="#constructor.new_UnsupportedAssetError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new APIError object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The Axios error.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.UnsupportedAssetError.html" class="tsd-signature-type tsd-kind-class">UnsupportedAssetError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_api_error.UnsupportedAssetError.html" class="tsd-signature-type tsd-kind-class">UnsupportedAssetError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L27">src/coinbase/api_error.ts:27</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Code</span><a href="#apiCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiCode">apiCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L18">src/coinbase/api_error.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Message</span><a href="#apiMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#apiMessage">apiMessage</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L19">src/coinbase/api_error.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#cause">cause</a></p><ul><li>Defined in node_modules/axios/index.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#code">code</a></p><ul><li>Defined in node_modules/axios/index.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#config">config</a></p><ul><li>Defined in node_modules/axios/index.d.ts:408</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="httpCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http<wbr/>Code</span><a href="#httpCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#httpCode">httpCode</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L17">src/coinbase/api_error.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isAxiosError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Axios<wbr/>Error</span><a href="#isAxiosError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Axios<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#isAxiosError">isAxiosError</a></p><ul><li>Defined in node_modules/axios/index.d.ts:412</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#message">message</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#name">name</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#request">request</a></p><ul><li>Defined in node_modules/axios/index.d.ts:410</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>response</span><a href="#response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#response">response</a></p><ul><li>Defined in node_modules/axios/index.d.ts:411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stack">stack</a></p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#status">status</a></p><ul><li>Defined in node_modules/axios/index.d.ts:413</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toJSON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="toJSON.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toJSON">toJSON</a></p><ul><li>Defined in node_modules/axios/index.d.ts:414</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ECONNABORTED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ECONNABORTED</span><a href="#ECONNABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ECONNABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ECONNABORTED"</span><span class="tsd-signature-symbol"> = "ECONNABORTED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ECONNABORTED">ECONNABORTED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:434</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION</span><a href="#ERR_BAD_OPTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION">ERR_BAD_OPTION</a></p><ul><li>Defined in node_modules/axios/index.d.ts:426</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_OPTION_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><a href="#ERR_BAD_OPTION_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_OPTION_VALUE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_OPTION_VALUE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_OPTION_VALUE">ERR_BAD_OPTION_VALUE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:425</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_REQUEST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>REQUEST</span><a href="#ERR_BAD_REQUEST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_REQUEST"</span><span class="tsd-signature-symbol"> = "ERR_BAD_REQUEST"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_REQUEST">ERR_BAD_REQUEST</a></p><ul><li>Defined in node_modules/axios/index.d.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_BAD_RESPONSE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span><a href="#ERR_BAD_RESPONSE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>BAD_<wbr/>RESPONSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_BAD_RESPONSE"</span><span class="tsd-signature-symbol"> = "ERR_BAD_RESPONSE"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_BAD_RESPONSE">ERR_BAD_RESPONSE</a></p><ul><li>Defined in node_modules/axios/index.d.ts:429</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_CANCELED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>CANCELED</span><a href="#ERR_CANCELED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>CANCELED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_CANCELED"</span><span class="tsd-signature-symbol"> = "ERR_CANCELED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_CANCELED">ERR_CANCELED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:433</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_DEPRECATED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>DEPRECATED</span><a href="#ERR_DEPRECATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>DEPRECATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_DEPRECATED"</span><span class="tsd-signature-symbol"> = "ERR_DEPRECATED"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_DEPRECATED">ERR_DEPRECATED</a></p><ul><li>Defined in node_modules/axios/index.d.ts:428</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_FR_TOO_MANY_REDIRECTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><a href="#ERR_FR_TOO_MANY_REDIRECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_FR_TOO_MANY_REDIRECTS"</span><span class="tsd-signature-symbol"> = "ERR_FR_TOO_MANY_REDIRECTS"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_FR_TOO_MANY_REDIRECTS">ERR_FR_TOO_MANY_REDIRECTS</a></p><ul><li>Defined in node_modules/axios/index.d.ts:424</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_INVALID_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>INVALID_<wbr/>URL</span><a href="#ERR_INVALID_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>INVALID_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_INVALID_URL"</span><span class="tsd-signature-symbol"> = "ERR_INVALID_URL"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_INVALID_URL">ERR_INVALID_URL</a></p><ul><li>Defined in node_modules/axios/index.d.ts:432</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NETWORK" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NETWORK</span><a href="#ERR_NETWORK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NETWORK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NETWORK"</span><span class="tsd-signature-symbol"> = "ERR_NETWORK"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NETWORK">ERR_NETWORK</a></p><ul><li>Defined in node_modules/axios/index.d.ts:427</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ERR_NOT_SUPPORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span><a href="#ERR_NOT_SUPPORT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ERR_<wbr/>NOT_<wbr/>SUPPORT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ERR_NOT_SUPPORT"</span><span class="tsd-signature-symbol"> = "ERR_NOT_SUPPORT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ERR_NOT_SUPPORT">ERR_NOT_SUPPORT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:431</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ETIMEDOUT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ETIMEDOUT</span><a href="#ETIMEDOUT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ETIMEDOUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ETIMEDOUT"</span><span class="tsd-signature-symbol"> = "ETIMEDOUT"</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#ETIMEDOUT">ETIMEDOUT</a></p><ul><li>Defined in node_modules/axios/index.d.ts:435</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the APIError.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the APIError</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L111">src/coinbase/api_error.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.UnsupportedAssetError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.UnsupportedAssetError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">customProps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="from.from-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="from.from-1.D" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">D</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">customProps</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="coinbase_api_error.APIError.html#from.from-1.D">D</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#from">from</a></p><ul><li>Defined in node_modules/axios/index.d.ts:416</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fromError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Error</span><a href="#fromError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fromError.fromError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a><a href="#fromError.fromError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a specific APIError based on the API error code.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The underlying error object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><span class="tsd-signature-symbol"> | </span><a href="coinbase_api_error.APIError.html" class="tsd-signature-type tsd-kind-class">APIError</a></h4><p>A specific APIError instance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="coinbase_api_error.APIError.html">APIError</a>.<a href="coinbase_api_error.APIError.html#fromError">fromError</a></p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L47">src/coinbase/api_error.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Code</span></a><a href="#apiMessage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Message</span></a><a href="#cause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cause</span></a><a href="#code" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#config" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#httpCode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http<wbr/>Code</span></a><a href="#isAxiosError" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Axios<wbr/>Error</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#request" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request</span></a><a href="#response" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#status" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#toJSON" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>toJSON</span></a><a href="#ECONNABORTED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ECONNABORTED</span></a><a href="#ERR_BAD_OPTION" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION</span></a><a href="#ERR_BAD_OPTION_VALUE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>OPTION_<wbr/>VALUE</span></a><a href="#ERR_BAD_REQUEST" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>REQUEST</span></a><a href="#ERR_BAD_RESPONSE" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>BAD_<wbr/>RESPONSE</span></a><a href="#ERR_CANCELED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>CANCELED</span></a><a href="#ERR_DEPRECATED" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>DEPRECATED</span></a><a href="#ERR_FR_TOO_MANY_REDIRECTS" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>FR_<wbr/>TOO_<wbr/>MANY_<wbr/>REDIRECTS</span></a><a href="#ERR_INVALID_URL" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>INVALID_<wbr/>URL</span></a><a href="#ERR_NETWORK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NETWORK</span></a><a href="#ERR_NOT_SUPPORT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ERR_<wbr/>NOT_<wbr/>SUPPORT</span></a><a href="#ETIMEDOUT" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ETIMEDOUT</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#toString" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#fromError" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Error</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_asset.Asset.html b/docs/classes/coinbase_asset.Asset.html index 3981de47..62c2e13d 100644 --- a/docs/classes/coinbase_asset.Asset.html +++ b/docs/classes/coinbase_asset.Asset.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Asset | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_asset.html">coinbase/asset</a></li><li><a href="coinbase_asset.Asset.html">Asset</a></li></ul><h1>Class Asset</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of an Asset.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L8">src/coinbase/asset.ts:8</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_asset.Asset.html#constructor" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L8">src/coinbase/asset.ts:8</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_asset.Asset.html#constructor" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_asset.Asset.html#assetId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset<wbr/>Id</span></a> <a href="coinbase_asset.Asset.html#contractAddress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>contract<wbr/>Address</span></a> <a href="coinbase_asset.Asset.html#decimals" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>decimals</span></a> @@ -17,31 +17,31 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset ID.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">contractAddress</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The address ID.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">decimals</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The number of decimals.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L22">src/coinbase/asset.ts:22</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="assetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>asset<wbr/>Id</span><a href="#assetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L10">src/coinbase/asset.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="contractAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>contract<wbr/>Address</span><a href="#contractAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">contract<wbr/>Address</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L11">src/coinbase/asset.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="decimals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>decimals</span><a href="#decimals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">decimals</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L12">src/coinbase/asset.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="networkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>network<wbr/>Id</span><a href="#networkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L9">src/coinbase/asset.ts:9</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="fromAtomicAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Atomic<wbr/>Amount</span><a href="#fromAtomicAmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromAtomicAmount.fromAtomicAmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Atomic<wbr/>Amount</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">wholeAmount</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><a href="#fromAtomicAmount.fromAtomicAmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts the amount of the Asset from atomic to whole units.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L22">src/coinbase/asset.ts:22</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="assetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>asset<wbr/>Id</span><a href="#assetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L10">src/coinbase/asset.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="contractAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>contract<wbr/>Address</span><a href="#contractAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">contract<wbr/>Address</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L11">src/coinbase/asset.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="decimals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>decimals</span><a href="#decimals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">decimals</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L12">src/coinbase/asset.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="networkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>network<wbr/>Id</span><a href="#networkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L9">src/coinbase/asset.ts:9</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="fromAtomicAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Atomic<wbr/>Amount</span><a href="#fromAtomicAmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromAtomicAmount.fromAtomicAmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Atomic<wbr/>Amount</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">wholeAmount</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><a href="#fromAtomicAmount.fromAtomicAmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts the amount of the Asset from atomic to whole units.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">wholeAmount</span>: <span class="tsd-signature-type">Decimal</span></span><div class="tsd-comment tsd-typography"><p>The atomic amount to convert to whole units.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Decimal</span></h4><p>The amount in atomic units</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L124">src/coinbase/asset.ts:124</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAssetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Asset<wbr/>Id</span><a href="#getAssetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAssetId.getAssetId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAssetId.getAssetId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Asset ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L124">src/coinbase/asset.ts:124</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAssetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Asset<wbr/>Id</span><a href="#getAssetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAssetId.getAssetId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAssetId.getAssetId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Asset ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Asset ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L142">src/coinbase/asset.ts:142</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="primaryDenomination" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>primary<wbr/>Denomination</span><a href="#primaryDenomination" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="primaryDenomination.primaryDenomination-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">primary<wbr/>Denomination</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#primaryDenomination.primaryDenomination-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the primary denomination for the Asset.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L142">src/coinbase/asset.ts:142</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="primaryDenomination" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>primary<wbr/>Denomination</span><a href="#primaryDenomination" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="primaryDenomination.primaryDenomination-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">primary<wbr/>Denomination</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#primaryDenomination.primaryDenomination-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the primary denomination for the Asset.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The primary denomination for the Asset.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L105">src/coinbase/asset.ts:105</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toAtomicAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Atomic<wbr/>Amount</span><a href="#toAtomicAmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toAtomicAmount.toAtomicAmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Atomic<wbr/>Amount</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">wholeAmount</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><a href="#toAtomicAmount.toAtomicAmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts the amount of the Asset from whole to atomic units.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L105">src/coinbase/asset.ts:105</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toAtomicAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Atomic<wbr/>Amount</span><a href="#toAtomicAmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toAtomicAmount.toAtomicAmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Atomic<wbr/>Amount</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">wholeAmount</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><a href="#toAtomicAmount.toAtomicAmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts the amount of the Asset from whole to atomic units.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">wholeAmount</span>: <span class="tsd-signature-type">Decimal</span></span><div class="tsd-comment tsd-typography"><p>The whole amount to convert to atomic units.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Decimal</span></h4><p>The amount in atomic units</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L115">src/coinbase/asset.ts:115</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the Asset.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L115">src/coinbase/asset.ts:115</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the Asset.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a string representation of the Asset</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L133">src/coinbase/asset.ts:133</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fetch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>fetch</span><a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetch.fetch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a><span class="tsd-signature-symbol">></span><a href="#fetch.fetch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetches the Asset with the provided Asset ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L133">src/coinbase/asset.ts:133</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fetch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>fetch</span><a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetch.fetch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a><span class="tsd-signature-symbol">></span><a href="#fetch.fetch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetches the Asset with the provided Asset ID.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The network ID.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset ID.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a><span class="tsd-signature-symbol">></span></h4><p>The Asset Class.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the Asset cannot be fetched.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L78">src/coinbase/asset.ts:78</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromModel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Model</span><a href="#fromModel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromModel.fromModel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Model</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span>, <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a><a href="#fromModel.fromModel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates an Asset from an Asset Model.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L78">src/coinbase/asset.ts:78</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromModel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Model</span><a href="#fromModel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromModel.fromModel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Model</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span>, <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a><a href="#fromModel.fromModel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates an Asset from an Asset Model.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">model</span>: <a href="../interfaces/client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a></span><div class="tsd-comment tsd-typography"><p>The Asset Model.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The Asset ID.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a></h4><p>The Asset Class.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the Asset Model is invalid.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L42">src/coinbase/asset.ts:42</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="primaryDenomination-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>primary<wbr/>Denomination</span><a href="#primaryDenomination-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="primaryDenomination-2.primaryDenomination-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">primary<wbr/>Denomination</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#primaryDenomination-2.primaryDenomination-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the primary denomination for the provided Asset ID. +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L42">src/coinbase/asset.ts:42</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="primaryDenomination-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>primary<wbr/>Denomination</span><a href="#primaryDenomination-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="primaryDenomination-2.primaryDenomination-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">primary<wbr/>Denomination</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#primaryDenomination-2.primaryDenomination-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the primary denomination for the provided Asset ID. For <code>gwei</code> and <code>wei</code> the primary denomination is <code>eth</code>. For all other assets, the primary denomination is the same asset ID.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The Asset ID.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The primary denomination for the Asset ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L94">src/coinbase/asset.ts:94</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#assetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset<wbr/>Id</span></a><a href="#contractAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>contract<wbr/>Address</span></a><a href="#decimals" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>decimals</span></a><a href="#networkId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a><a href="#fromAtomicAmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Atomic<wbr/>Amount</span></a><a href="#getAssetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Id</span></a><a href="#primaryDenomination" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>primary<wbr/>Denomination</span></a><a href="#toAtomicAmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Atomic<wbr/>Amount</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#fetch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a><a href="#fromModel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Model</span></a><a href="#primaryDenomination-2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>primary<wbr/>Denomination</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L94">src/coinbase/asset.ts:94</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#assetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset<wbr/>Id</span></a><a href="#contractAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>contract<wbr/>Address</span></a><a href="#decimals" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>decimals</span></a><a href="#networkId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a><a href="#fromAtomicAmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Atomic<wbr/>Amount</span></a><a href="#getAssetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Id</span></a><a href="#primaryDenomination" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>primary<wbr/>Denomination</span></a><a href="#toAtomicAmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Atomic<wbr/>Amount</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#fetch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a><a href="#fromModel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Model</span></a><a href="#primaryDenomination-2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>primary<wbr/>Denomination</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_authenticator.CoinbaseAuthenticator.html b/docs/classes/coinbase_authenticator.CoinbaseAuthenticator.html index e808726c..6aa1aee0 100644 --- a/docs/classes/coinbase_authenticator.CoinbaseAuthenticator.html +++ b/docs/classes/coinbase_authenticator.CoinbaseAuthenticator.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CoinbaseAuthenticator | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_authenticator.html">coinbase/authenticator</a></li><li><a href="coinbase_authenticator.CoinbaseAuthenticator.html">CoinbaseAuthenticator</a></li></ul><h1>Class CoinbaseAuthenticator</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A class that builds JWTs for authenticating with the Coinbase Platform APIs.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/authenticator.ts#L11">src/coinbase/authenticator.ts:11</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_authenticator.CoinbaseAuthenticator.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/authenticator.ts#L11">src/coinbase/authenticator.ts:11</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_authenticator.CoinbaseAuthenticator.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_authenticator.CoinbaseAuthenticator.html#apiKey" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key</span></a> <a href="coinbase_authenticator.CoinbaseAuthenticator.html#privateKey" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>private<wbr/>Key</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_authenticator.CoinbaseAuthenticator.html#authenticateRequest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>authenticate<wbr/>Request</span></a> @@ -9,20 +9,20 @@ </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_CoinbaseAuthenticator" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Coinbase<wbr/>Authenticator</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">apiKey</span>, <span class="tsd-kind-parameter">privateKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_authenticator.CoinbaseAuthenticator.html" class="tsd-signature-type tsd-kind-class">CoinbaseAuthenticator</a><a href="#constructor.new_CoinbaseAuthenticator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes the Authenticator.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">apiKey</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The API key name.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">privateKey</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The private key associated with the API key.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_authenticator.CoinbaseAuthenticator.html" class="tsd-signature-type tsd-kind-class">CoinbaseAuthenticator</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/authenticator.ts#L21">src/coinbase/authenticator.ts:21</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="apiKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>api<wbr/>Key</span><a href="#apiKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/authenticator.ts#L12">src/coinbase/authenticator.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="privateKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>private<wbr/>Key</span><a href="#privateKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">private<wbr/>Key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/authenticator.ts#L13">src/coinbase/authenticator.ts:13</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="authenticateRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>authenticate<wbr/>Request</span><a href="#authenticateRequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="authenticateRequest.authenticateRequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">authenticate<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span>, <span class="tsd-kind-parameter">debugging</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#authenticateRequest.authenticateRequest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Middleware to intercept requests and add JWT to Authorization header.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_authenticator.CoinbaseAuthenticator.html" class="tsd-signature-type tsd-kind-class">CoinbaseAuthenticator</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/authenticator.ts#L21">src/coinbase/authenticator.ts:21</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="apiKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>api<wbr/>Key</span><a href="#apiKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/authenticator.ts#L12">src/coinbase/authenticator.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="privateKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>private<wbr/>Key</span><a href="#privateKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">private<wbr/>Key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/authenticator.ts#L13">src/coinbase/authenticator.ts:13</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="authenticateRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>authenticate<wbr/>Request</span><a href="#authenticateRequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="authenticateRequest.authenticateRequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">authenticate<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span>, <span class="tsd-kind-parameter">debugging</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#authenticateRequest.authenticateRequest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Middleware to intercept requests and add JWT to Authorization header.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The request configuration.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">debugging</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Flag to enable debugging.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InternalAxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>The request configuration with the Authorization header added.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If JWT could not be built.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/authenticator.ts#L34">src/coinbase/authenticator.ts:34</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="buildJWT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>buildJWT</span><a href="#buildJWT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="buildJWT.buildJWT-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">buildJWT</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">method</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#buildJWT.buildJWT-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Builds the JWT for the given API endpoint URL.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/authenticator.ts#L34">src/coinbase/authenticator.ts:34</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="buildJWT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>buildJWT</span><a href="#buildJWT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="buildJWT.buildJWT-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">buildJWT</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">method</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#buildJWT.buildJWT-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Builds the JWT for the given API endpoint URL.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>URL of the API endpoint.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">method</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "GET"</span></span><div class="tsd-comment tsd-typography"><p>HTTP method of the request.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>JWT token.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the private key is not in the correct format.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/authenticator.ts#L56">src/coinbase/authenticator.ts:56</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="extractPemKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>extract<wbr/>Pem<wbr/>Key</span><a href="#extractPemKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="extractPemKey.extractPemKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">extract<wbr/>Pem<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">privateKeyString</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#extractPemKey.extractPemKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Extracts the PEM key from the given private key string.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/authenticator.ts#L56">src/coinbase/authenticator.ts:56</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="extractPemKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>extract<wbr/>Pem<wbr/>Key</span><a href="#extractPemKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="extractPemKey.extractPemKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">extract<wbr/>Pem<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">privateKeyString</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#extractPemKey.extractPemKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Extracts the PEM key from the given private key string.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">privateKeyString</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The private key string.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The PEM key.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the private key string is not in the correct format.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/authenticator.ts#L106">src/coinbase/authenticator.ts:106</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="nonce" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>nonce</span><a href="#nonce" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="nonce.nonce-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">nonce</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#nonce.nonce-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Generates a random nonce for the JWT.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/authenticator.ts#L106">src/coinbase/authenticator.ts:106</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="nonce" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>nonce</span><a href="#nonce" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="nonce.nonce-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">nonce</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#nonce.nonce-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Generates a random nonce for the JWT.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The generated nonce.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/authenticator.ts#L121">src/coinbase/authenticator.ts:121</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiKey" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key</span></a><a href="#privateKey" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>private<wbr/>Key</span></a><a href="#authenticateRequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>authenticate<wbr/>Request</span></a><a href="#buildJWT" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>buildJWT</span></a><a href="#extractPemKey" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>extract<wbr/>Pem<wbr/>Key</span></a><a href="#nonce" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>nonce</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/authenticator.ts#L121">src/coinbase/authenticator.ts:121</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiKey" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key</span></a><a href="#privateKey" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>private<wbr/>Key</span></a><a href="#authenticateRequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>authenticate<wbr/>Request</span></a><a href="#buildJWT" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>buildJWT</span></a><a href="#extractPemKey" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>extract<wbr/>Pem<wbr/>Key</span></a><a href="#nonce" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>nonce</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_balance.Balance.html b/docs/classes/coinbase_balance.Balance.html index 903867c7..996e2757 100644 --- a/docs/classes/coinbase_balance.Balance.html +++ b/docs/classes/coinbase_balance.Balance.html @@ -1,14 +1,14 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Balance | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_balance.html">coinbase/balance</a></li><li><a href="coinbase_balance.Balance.html">Balance</a></li></ul><h1>Class Balance</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of a balance.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/balance.ts#L6">src/coinbase/balance.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_balance.Balance.html#amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/balance.ts#L6">src/coinbase/balance.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_balance.Balance.html#amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a> <a href="coinbase_balance.Balance.html#asset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset?</span></a> <a href="coinbase_balance.Balance.html#assetId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset<wbr/>Id</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_balance.Balance.html#fromModel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Model</span></a> <a href="coinbase_balance.Balance.html#fromModelAndAssetId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Model<wbr/>And<wbr/>Asset<wbr/>Id</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>amount</span><a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Decimal</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/balance.ts#L7">src/coinbase/balance.ts:7</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>asset</span><a href="#asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset</span><span class="tsd-signature-symbol">?:</span> <a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/balance.ts#L9">src/coinbase/balance.ts:9</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="assetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>asset<wbr/>Id</span><a href="#assetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/balance.ts#L8">src/coinbase/balance.ts:8</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="fromModel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Model</span><a href="#fromModel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromModel.fromModel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Model</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_balance.Balance.html" class="tsd-signature-type tsd-kind-class">Balance</a><a href="#fromModel.fromModel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts a BalanceModel into a Balance object.</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>amount</span><a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Decimal</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/balance.ts#L7">src/coinbase/balance.ts:7</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>asset</span><a href="#asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset</span><span class="tsd-signature-symbol">?:</span> <a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/balance.ts#L9">src/coinbase/balance.ts:9</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="assetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>asset<wbr/>Id</span><a href="#assetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/balance.ts#L8">src/coinbase/balance.ts:8</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="fromModel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Model</span><a href="#fromModel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromModel.fromModel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Model</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_balance.Balance.html" class="tsd-signature-type tsd-kind-class">Balance</a><a href="#fromModel.fromModel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts a BalanceModel into a Balance object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">model</span>: <a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></span><div class="tsd-comment tsd-typography"><p>The balance model object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_balance.Balance.html" class="tsd-signature-type tsd-kind-class">Balance</a></h4><p>The Balance object.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/balance.ts#L31">src/coinbase/balance.ts:31</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromModelAndAssetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Model<wbr/>And<wbr/>Asset<wbr/>Id</span><a href="#fromModelAndAssetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromModelAndAssetId.fromModelAndAssetId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Model<wbr/>And<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span>, <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_balance.Balance.html" class="tsd-signature-type tsd-kind-class">Balance</a><a href="#fromModelAndAssetId.fromModelAndAssetId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts a BalanceModel and asset ID into a Balance object.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/balance.ts#L31">src/coinbase/balance.ts:31</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromModelAndAssetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Model<wbr/>And<wbr/>Asset<wbr/>Id</span><a href="#fromModelAndAssetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromModelAndAssetId.fromModelAndAssetId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Model<wbr/>And<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span>, <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_balance.Balance.html" class="tsd-signature-type tsd-kind-class">Balance</a><a href="#fromModelAndAssetId.fromModelAndAssetId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts a BalanceModel and asset ID into a Balance object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">model</span>: <a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></span><div class="tsd-comment tsd-typography"><p>The balance model object.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset ID.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_balance.Balance.html" class="tsd-signature-type tsd-kind-class">Balance</a></h4><p>The Balance object.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/balance.ts#L47">src/coinbase/balance.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#asset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset</span></a><a href="#assetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset<wbr/>Id</span></a><a href="#fromModel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Model</span></a><a href="#fromModelAndAssetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Model<wbr/>And<wbr/>Asset<wbr/>Id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/balance.ts#L47">src/coinbase/balance.ts:47</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#asset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset</span></a><a href="#assetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset<wbr/>Id</span></a><a href="#fromModel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Model</span></a><a href="#fromModelAndAssetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Model<wbr/>And<wbr/>Asset<wbr/>Id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_balance_map.BalanceMap.html b/docs/classes/coinbase_balance_map.BalanceMap.html index ab5c58f6..0a98b727 100644 --- a/docs/classes/coinbase_balance_map.BalanceMap.html +++ b/docs/classes/coinbase_balance_map.BalanceMap.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BalanceMap | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_balance_map.html">coinbase/balance_map</a></li><li><a href="coinbase_balance_map.BalanceMap.html">BalanceMap</a></li></ul><h1>Class BalanceMap</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A convenience class for storing and manipulating Asset balances in a human-readable format.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">BalanceMap</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/balance_map.ts#L8">src/coinbase/balance_map.ts:8</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_balance_map.BalanceMap.html#constructor" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">BalanceMap</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/balance_map.ts#L8">src/coinbase/balance_map.ts:8</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_balance_map.BalanceMap.html#constructor" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_balance_map.BalanceMap.html#_toStringTag_" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>[to<wbr/>String<wbr/>Tag]</span></a> <a href="coinbase_balance_map.BalanceMap.html#size" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size</span></a> <a href="coinbase_balance_map.BalanceMap.html#_species_" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>[species]</span></a> @@ -20,7 +20,7 @@ </div><aside class="tsd-sources"><p>Inherited from Map.size</p><ul><li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:45</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_species_" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>[species]</span><a href="#_species_" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">[species]</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MapConstructor</span></div><aside class="tsd-sources"><p>Inherited from Map.[species]</p><ul><li>Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:319</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_iterator_" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>[iterator]</span><a href="#_iterator_" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="_iterator_._iterator_-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">[iterator]</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><a href="#_iterator_._iterator_-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an iterable of entries in the map.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Map.[iterator]</p><ul><li>Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="add" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add</span><a href="#add" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="add.add-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">balance</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#add.add-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a balance to the map.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">balance</span>: <a href="coinbase_balance.Balance.html" class="tsd-signature-type tsd-kind-class">Balance</a></span><div class="tsd-comment tsd-typography"><p>The balance to add to the map.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/balance_map.ts#L29">src/coinbase/balance_map.ts:29</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="clear" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear</span><a href="#clear" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="clear.clear-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clear</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#clear.clear-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from Map.clear</p><ul><li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="delete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="delete.delete-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#delete.delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if an element in the Map existed and has been removed, or false if the element does not exist.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/balance_map.ts#L29">src/coinbase/balance_map.ts:29</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="clear" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear</span><a href="#clear" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="clear.clear-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clear</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#clear.clear-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from Map.clear</p><ul><li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="delete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="delete.delete-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#delete.delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if an element in the Map existed and has been removed, or false if the element does not exist.</p> <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Map.delete</p><ul><li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entries" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>entries</span><a href="#entries" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="entries.entries-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">entries</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><a href="#entries.entries-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an iterable of key, value pairs for every entry in the map.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Map.entries</p><ul><li>Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:124</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="forEach" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>for<wbr/>Each</span><a href="#forEach" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="forEach.forEach-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">for<wbr/>Each</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callbackfn</span>, <span class="tsd-kind-parameter">thisArg</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#forEach.forEach-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Executes a provided function once per each key/value pair in the Map, in insertion order.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callbackfn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">map</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">map</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Decimal</span></span></li><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">map</span>: <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Map.forEach</p><ul><li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="get.get-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Decimal</span><a href="#get.get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.</p> @@ -30,8 +30,8 @@ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Map.keys</p><ul><li>Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:129</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="set" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set</span><a href="#set" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="set.set-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#set.set-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Decimal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Map.set</p><ul><li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:41</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the balance map.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The string representation of the balance map.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/balance_map.ts#L41">src/coinbase/balance_map.ts:41</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="values" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>values</span><a href="#values" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="values.values-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">values</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#values.values-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an iterable of values in the map</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/balance_map.ts#L41">src/coinbase/balance_map.ts:41</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="values" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>values</span><a href="#values" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="values.values-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">values</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#values.values-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an iterable of values in the map</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Map.values</p><ul><li>Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:134</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Balances</span><a href="#fromBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromBalances.fromBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">balances</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><a href="#fromBalances.fromBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts a list of Balance models to a BalanceMap.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">balances</span>: <a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The list of balances fetched from the API.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a></h4><p>The converted BalanceMap object.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/balance_map.ts#L15">src/coinbase/balance_map.ts:15</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#_toStringTag_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>[to<wbr/>String<wbr/>Tag]</span></a><a href="#size" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size</span></a><a href="#_species_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>[species]</span></a><a href="#_iterator_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>[iterator]</span></a><a href="#add" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add</span></a><a href="#clear" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear</span></a><a href="#delete" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#entries" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>entries</span></a><a href="#forEach" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>for<wbr/>Each</span></a><a href="#get" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a><a href="#has" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has</span></a><a href="#keys" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>keys</span></a><a href="#set" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#values" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>values</span></a><a href="#fromBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Balances</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/balance_map.ts#L15">src/coinbase/balance_map.ts:15</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#_toStringTag_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>[to<wbr/>String<wbr/>Tag]</span></a><a href="#size" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size</span></a><a href="#_species_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>[species]</span></a><a href="#_iterator_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>[iterator]</span></a><a href="#add" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add</span></a><a href="#clear" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear</span></a><a href="#delete" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#entries" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>entries</span></a><a href="#forEach" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>for<wbr/>Each</span></a><a href="#get" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a><a href="#has" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has</span></a><a href="#keys" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>keys</span></a><a href="#set" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#values" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>values</span></a><a href="#fromBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Balances</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_coinbase.Coinbase.html b/docs/classes/coinbase_coinbase.Coinbase.html index 46e587fe..e4dabd05 100644 --- a/docs/classes/coinbase_coinbase.Coinbase.html +++ b/docs/classes/coinbase_coinbase.Coinbase.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Coinbase | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_coinbase.html">coinbase/coinbase</a></li><li><a href="coinbase_coinbase.Coinbase.html">Coinbase</a></li></ul><h1>Class Coinbase</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The Coinbase SDK.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/coinbase.ts#L28">src/coinbase/coinbase.ts:28</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_coinbase.Coinbase.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/coinbase.ts#L28">src/coinbase/coinbase.ts:28</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_coinbase.Coinbase.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_coinbase.Coinbase.html#apiClients" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Clients</span></a> <a href="coinbase_coinbase.Coinbase.html#apiKeyPrivateKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key<wbr/>Private<wbr/>Key</span></a> <a href="coinbase_coinbase.Coinbase.html#assets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>assets</span></a> @@ -13,23 +13,23 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/coinbase_types.CoinbaseOptions.html" class="tsd-signature-type tsd-kind-type-alias">CoinbaseOptions</a></span><div class="tsd-comment tsd-typography"><p>The constructor options.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_coinbase.Coinbase.html" class="tsd-signature-type tsd-kind-class">Coinbase</a></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the configuration is invalid.</p> <h4>Throws</h4><p>If not able to create JWT token.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/coinbase.ts#L83">src/coinbase/coinbase.ts:83</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="apiClients" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>api<wbr/>Clients</span><a href="#apiClients" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Clients</span><span class="tsd-signature-symbol">:</span> <a href="../types/coinbase_types.ApiClients.html" class="tsd-signature-type tsd-kind-type-alias">ApiClients</a><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/coinbase.ts#L54">src/coinbase/coinbase.ts:54</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="apiKeyPrivateKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>api<wbr/>Key<wbr/>Private<wbr/>Key</span><a href="#apiKeyPrivateKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Key<wbr/>Private<wbr/>Key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The CDP API key Private Key.</p> -</div><div class="tsd-comment tsd-typography"><h4>Constant</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/coinbase.ts#L61">src/coinbase/coinbase.ts:61</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="assets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>assets</span><a href="#assets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">assets</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">Eth</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Gwei</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Usdc</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Wei</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Weth</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>The list of supported assets.</p> -</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">Eth</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Gwei</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Usdc</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Wei</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Weth</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"><h4>Constant</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/coinbase.ts#L46">src/coinbase/coinbase.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="networks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>networks</span><a href="#networks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">networks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">BaseMainnet</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">BaseSepolia</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">EthereumHolesky</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">EthereumMainnet</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>The list of supported networks.</p> -</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">Base<wbr/>Mainnet</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Base<wbr/>Sepolia</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Ethereum<wbr/>Holesky</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Ethereum<wbr/>Mainnet</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"><h4>Constant</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/coinbase.ts#L34">src/coinbase/coinbase.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="useServerSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>use<wbr/>Server<wbr/>Signer</span><a href="#useServerSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">use<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether to use a server signer or not.</p> -</div><div class="tsd-comment tsd-typography"><h4>Constant</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/coinbase.ts#L68">src/coinbase/coinbase.ts:68</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getDefaultUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Default<wbr/>User</span><a href="#getDefaultUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDefaultUser.getDefaultUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Default<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_user.User.html" class="tsd-signature-type tsd-kind-class">User</a><span class="tsd-signature-symbol">></span><a href="#getDefaultUser.getDefaultUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns User object for the default user.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/coinbase.ts#L83">src/coinbase/coinbase.ts:83</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="apiClients" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>api<wbr/>Clients</span><a href="#apiClients" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Clients</span><span class="tsd-signature-symbol">:</span> <a href="../types/coinbase_types.ApiClients.html" class="tsd-signature-type tsd-kind-type-alias">ApiClients</a><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/coinbase.ts#L54">src/coinbase/coinbase.ts:54</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="apiKeyPrivateKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>api<wbr/>Key<wbr/>Private<wbr/>Key</span><a href="#apiKeyPrivateKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Key<wbr/>Private<wbr/>Key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The CDP API key Private Key.</p> +</div><div class="tsd-comment tsd-typography"><h4>Constant</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/coinbase.ts#L61">src/coinbase/coinbase.ts:61</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="assets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>assets</span><a href="#assets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">assets</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">Eth</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Gwei</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Usdc</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Wei</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Weth</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>The list of supported assets.</p> +</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">Eth</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Gwei</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Usdc</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Wei</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Weth</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"><h4>Constant</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/coinbase.ts#L46">src/coinbase/coinbase.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="networks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>networks</span><a href="#networks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">networks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">BaseMainnet</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">BaseSepolia</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">EthereumHolesky</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">EthereumMainnet</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>The list of supported networks.</p> +</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">Base<wbr/>Mainnet</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Base<wbr/>Sepolia</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Ethereum<wbr/>Holesky</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Ethereum<wbr/>Mainnet</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"><h4>Constant</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/coinbase.ts#L34">src/coinbase/coinbase.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="useServerSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>use<wbr/>Server<wbr/>Signer</span><a href="#useServerSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">use<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether to use a server signer or not.</p> +</div><div class="tsd-comment tsd-typography"><h4>Constant</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/coinbase.ts#L68">src/coinbase/coinbase.ts:68</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getDefaultUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Default<wbr/>User</span><a href="#getDefaultUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDefaultUser.getDefaultUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Default<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_user.User.html" class="tsd-signature-type tsd-kind-class">User</a><span class="tsd-signature-symbol">></span><a href="#getDefaultUser.getDefaultUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns User object for the default user.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_user.User.html" class="tsd-signature-type tsd-kind-class">User</a><span class="tsd-signature-symbol">></span></h4><p>The default user.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/coinbase.ts#L201">src/coinbase/coinbase.ts:201</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="configureFromJson" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>configure<wbr/>From<wbr/>Json</span><a href="#configureFromJson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="configureFromJson.configureFromJson-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">configure<wbr/>From<wbr/>Json</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_coinbase.Coinbase.html" class="tsd-signature-type tsd-kind-class">Coinbase</a><a href="#configureFromJson.configureFromJson-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reads the API key and private key from a JSON file and initializes the Coinbase SDK.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/coinbase.ts#L201">src/coinbase/coinbase.ts:201</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="configureFromJson" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>configure<wbr/>From<wbr/>Json</span><a href="#configureFromJson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="configureFromJson.configureFromJson-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">configure<wbr/>From<wbr/>Json</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_coinbase.Coinbase.html" class="tsd-signature-type tsd-kind-class">Coinbase</a><a href="#configureFromJson.configureFromJson-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reads the API key and private key from a JSON file and initializes the Coinbase SDK.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/coinbase_types.CoinbaseConfigureFromJsonOptions.html" class="tsd-signature-type tsd-kind-type-alias">CoinbaseConfigureFromJsonOptions</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The configuration options.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_coinbase.Coinbase.html" class="tsd-signature-type tsd-kind-class">Coinbase</a></h4><p>A new instance of the Coinbase SDK.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the file does not exist or the configuration values are missing/invalid.</p> <h4>Throws</h4><p>If the configuration is invalid.</p> <h4>Throws</h4><p>If not able to create JWT token.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/coinbase.ts#L139">src/coinbase/coinbase.ts:139</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="normalizeNetwork" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>normalize<wbr/>Network</span><a href="#normalizeNetwork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="normalizeNetwork.normalizeNetwork-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">normalize<wbr/>Network</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">network</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#normalizeNetwork.normalizeNetwork-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts a network symbol to a string, replacing underscores with hyphens.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/coinbase.ts#L139">src/coinbase/coinbase.ts:139</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="normalizeNetwork" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>normalize<wbr/>Network</span><a href="#normalizeNetwork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="normalizeNetwork.normalizeNetwork-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">normalize<wbr/>Network</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">network</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#normalizeNetwork.normalizeNetwork-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts a network symbol to a string, replacing underscores with hyphens.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">network</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The network symbol to convert</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>the converted string</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/coinbase.ts#L181">src/coinbase/coinbase.ts:181</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toAssetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>to<wbr/>Asset<wbr/>Id</span><a href="#toAssetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toAssetId.toAssetId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">asset</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toAssetId.toAssetId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts a string to a symbol, replacing hyphens with underscores.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/coinbase.ts#L181">src/coinbase/coinbase.ts:181</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toAssetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>to<wbr/>Asset<wbr/>Id</span><a href="#toAssetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toAssetId.toAssetId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">asset</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toAssetId.toAssetId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts a string to a symbol, replacing hyphens with underscores.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">asset</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The string to convert</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>the converted symbol</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/coinbase.ts#L191">src/coinbase/coinbase.ts:191</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiClients" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Clients</span></a><a href="#apiKeyPrivateKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key<wbr/>Private<wbr/>Key</span></a><a href="#assets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>assets</span></a><a href="#networks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>networks</span></a><a href="#useServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Server<wbr/>Signer</span></a><a href="#getDefaultUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default<wbr/>User</span></a><a href="#configureFromJson" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure<wbr/>From<wbr/>Json</span></a><a href="#normalizeNetwork" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>normalize<wbr/>Network</span></a><a href="#toAssetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Asset<wbr/>Id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/coinbase.ts#L191">src/coinbase/coinbase.ts:191</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiClients" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Clients</span></a><a href="#apiKeyPrivateKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key<wbr/>Private<wbr/>Key</span></a><a href="#assets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>assets</span></a><a href="#networks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>networks</span></a><a href="#useServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Server<wbr/>Signer</span></a><a href="#getDefaultUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default<wbr/>User</span></a><a href="#configureFromJson" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure<wbr/>From<wbr/>Json</span></a><a href="#normalizeNetwork" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>normalize<wbr/>Network</span></a><a href="#toAssetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Asset<wbr/>Id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_errors.ArgumentError.html b/docs/classes/coinbase_errors.ArgumentError.html index a420343d..1744e2ea 100644 --- a/docs/classes/coinbase_errors.ArgumentError.html +++ b/docs/classes/coinbase_errors.ArgumentError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ArgumentError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_errors.html">coinbase/errors</a></li><li><a href="coinbase_errors.ArgumentError.html">ArgumentError</a></li></ul><h1>Class ArgumentError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ArgumentError is thrown when an argument is invalid.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">ArgumentError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L24">src/coinbase/errors.ts:24</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_errors.ArgumentError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">ArgumentError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L24">src/coinbase/errors.ts:24</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_errors.ArgumentError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_errors.ArgumentError.html#message" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a> <a href="coinbase_errors.ArgumentError.html#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a> <a href="coinbase_errors.ArgumentError.html#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack?</span></a> @@ -9,7 +9,7 @@ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_errors.ArgumentError.html#captureStackTrace" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ArgumentError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Argument<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.ArgumentError.html" class="tsd-signature-type tsd-kind-class">ArgumentError</a><a href="#constructor.new_ArgumentError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new ArgumentError instance.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ArgumentError.DEFAULT_MESSAGE</span></span><div class="tsd-comment tsd-typography"><p>The error message.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.ArgumentError.html" class="tsd-signature-type tsd-kind-class">ArgumentError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L32">src/coinbase/errors.ts:32</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DEFAULT_MESSAGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>DEFAULT_<wbr/>MESSAGE</span><a href="#DEFAULT_MESSAGE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>MESSAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "Argument Error"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L25">src/coinbase/errors.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.ArgumentError.html" class="tsd-signature-type tsd-kind-class">ArgumentError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L32">src/coinbase/errors.ts:32</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DEFAULT_MESSAGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>DEFAULT_<wbr/>MESSAGE</span><a href="#DEFAULT_MESSAGE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>MESSAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "Argument Error"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L25">src/coinbase/errors.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from Error.prepareStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Error.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Error.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#DEFAULT_MESSAGE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>MESSAGE</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InternalError.html b/docs/classes/coinbase_errors.InternalError.html index 3d646560..4e9fce6c 100644 --- a/docs/classes/coinbase_errors.InternalError.html +++ b/docs/classes/coinbase_errors.InternalError.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InternalError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_errors.html">coinbase/errors</a></li><li><a href="coinbase_errors.InternalError.html">InternalError</a></li></ul><h1>Class InternalError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>InternalError is thrown when there is an internal error in the SDK.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">InternalError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L44">src/coinbase/errors.ts:44</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_errors.InternalError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">InternalError</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L44">src/coinbase/errors.ts:44</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_errors.InternalError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_errors.InternalError.html#message" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a> <a href="coinbase_errors.InternalError.html#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a> <a href="coinbase_errors.InternalError.html#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack?</span></a> @@ -9,7 +9,7 @@ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_errors.InternalError.html#captureStackTrace" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InternalError" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Internal<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a><a href="#constructor.new_InternalError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new InternalError instance.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = InternalError.DEFAULT_MESSAGE</span></span><div class="tsd-comment tsd-typography"><p>The error message.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L52">src/coinbase/errors.ts:52</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DEFAULT_MESSAGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>DEFAULT_<wbr/>MESSAGE</span><a href="#DEFAULT_MESSAGE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>MESSAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "Internal Error"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L45">src/coinbase/errors.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InternalError.html" class="tsd-signature-type tsd-kind-class">InternalError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L52">src/coinbase/errors.ts:52</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DEFAULT_MESSAGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>DEFAULT_<wbr/>MESSAGE</span><a href="#DEFAULT_MESSAGE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>MESSAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "Internal Error"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L45">src/coinbase/errors.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from Error.prepareStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Error.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Error.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#DEFAULT_MESSAGE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>MESSAGE</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html b/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html index da62dc0d..78987e38 100644 --- a/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html +++ b/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidAPIKeyFormat | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_errors.html">coinbase/errors</a></li><li><a href="coinbase_errors.InvalidAPIKeyFormat.html">InvalidAPIKeyFormat</a></li></ul><h1>Class InvalidAPIKeyFormat</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>InvalidaAPIKeyFormat error is thrown when the API key format is invalid.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">InvalidAPIKeyFormat</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L4">src/coinbase/errors.ts:4</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_errors.InvalidAPIKeyFormat.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">InvalidAPIKeyFormat</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L4">src/coinbase/errors.ts:4</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_errors.InvalidAPIKeyFormat.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_errors.InvalidAPIKeyFormat.html#message" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a> <a href="coinbase_errors.InvalidAPIKeyFormat.html#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a> <a href="coinbase_errors.InvalidAPIKeyFormat.html#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack?</span></a> @@ -9,7 +9,7 @@ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_errors.InvalidAPIKeyFormat.html#captureStackTrace" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidAPIKeyFormat" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>InvalidAPIKey<wbr/>Format</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InvalidAPIKeyFormat.html" class="tsd-signature-type tsd-kind-class">InvalidAPIKeyFormat</a><a href="#constructor.new_InvalidAPIKeyFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new InvalidAPIKeyFormat instance.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = InvalidAPIKeyFormat.DEFAULT_MESSAGE</span></span><div class="tsd-comment tsd-typography"><p>The error message.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InvalidAPIKeyFormat.html" class="tsd-signature-type tsd-kind-class">InvalidAPIKeyFormat</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L12">src/coinbase/errors.ts:12</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DEFAULT_MESSAGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>DEFAULT_<wbr/>MESSAGE</span><a href="#DEFAULT_MESSAGE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>MESSAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "Invalid API key format"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L5">src/coinbase/errors.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InvalidAPIKeyFormat.html" class="tsd-signature-type tsd-kind-class">InvalidAPIKeyFormat</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L12">src/coinbase/errors.ts:12</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DEFAULT_MESSAGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>DEFAULT_<wbr/>MESSAGE</span><a href="#DEFAULT_MESSAGE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>MESSAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "Invalid API key format"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L5">src/coinbase/errors.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from Error.prepareStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Error.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Error.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#DEFAULT_MESSAGE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>MESSAGE</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidConfiguration.html b/docs/classes/coinbase_errors.InvalidConfiguration.html index 332df433..1d6df44b 100644 --- a/docs/classes/coinbase_errors.InvalidConfiguration.html +++ b/docs/classes/coinbase_errors.InvalidConfiguration.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidConfiguration | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_errors.html">coinbase/errors</a></li><li><a href="coinbase_errors.InvalidConfiguration.html">InvalidConfiguration</a></li></ul><h1>Class InvalidConfiguration</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>InvalidConfiguration error is thrown when apikey/privateKey configuration is invalid.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">InvalidConfiguration</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L64">src/coinbase/errors.ts:64</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_errors.InvalidConfiguration.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">InvalidConfiguration</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L64">src/coinbase/errors.ts:64</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_errors.InvalidConfiguration.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_errors.InvalidConfiguration.html#message" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a> <a href="coinbase_errors.InvalidConfiguration.html#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a> <a href="coinbase_errors.InvalidConfiguration.html#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack?</span></a> @@ -9,7 +9,7 @@ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_errors.InvalidConfiguration.html#captureStackTrace" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidConfiguration" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>Configuration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InvalidConfiguration.html" class="tsd-signature-type tsd-kind-class">InvalidConfiguration</a><a href="#constructor.new_InvalidConfiguration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new InvalidConfiguration instance.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = InvalidConfiguration.DEFAULT_MESSAGE</span></span><div class="tsd-comment tsd-typography"><p>The error message.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InvalidConfiguration.html" class="tsd-signature-type tsd-kind-class">InvalidConfiguration</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L72">src/coinbase/errors.ts:72</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DEFAULT_MESSAGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>DEFAULT_<wbr/>MESSAGE</span><a href="#DEFAULT_MESSAGE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>MESSAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "Invalid configuration"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L65">src/coinbase/errors.ts:65</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InvalidConfiguration.html" class="tsd-signature-type tsd-kind-class">InvalidConfiguration</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L72">src/coinbase/errors.ts:72</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DEFAULT_MESSAGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>DEFAULT_<wbr/>MESSAGE</span><a href="#DEFAULT_MESSAGE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>MESSAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "Invalid configuration"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L65">src/coinbase/errors.ts:65</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from Error.prepareStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Error.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Error.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#DEFAULT_MESSAGE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>MESSAGE</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidUnsignedPayload.html b/docs/classes/coinbase_errors.InvalidUnsignedPayload.html index 96b855cd..76f4cb4e 100644 --- a/docs/classes/coinbase_errors.InvalidUnsignedPayload.html +++ b/docs/classes/coinbase_errors.InvalidUnsignedPayload.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InvalidUnsignedPayload | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_errors.html">coinbase/errors</a></li><li><a href="coinbase_errors.InvalidUnsignedPayload.html">InvalidUnsignedPayload</a></li></ul><h1>Class InvalidUnsignedPayload</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>InvalidUnsignedPayload error is thrown when the unsigned payload is invalid.</p> -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">InvalidUnsignedPayload</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L84">src/coinbase/errors.ts:84</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_errors.InvalidUnsignedPayload.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">InvalidUnsignedPayload</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L84">src/coinbase/errors.ts:84</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_errors.InvalidUnsignedPayload.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_errors.InvalidUnsignedPayload.html#message" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a> <a href="coinbase_errors.InvalidUnsignedPayload.html#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a> <a href="coinbase_errors.InvalidUnsignedPayload.html#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack?</span></a> @@ -9,7 +9,7 @@ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_errors.InvalidUnsignedPayload.html#captureStackTrace" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_InvalidUnsignedPayload" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Invalid<wbr/>Unsigned<wbr/>Payload</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_errors.InvalidUnsignedPayload.html" class="tsd-signature-type tsd-kind-class">InvalidUnsignedPayload</a><a href="#constructor.new_InvalidUnsignedPayload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new InvalidUnsignedPayload instance.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = InvalidUnsignedPayload.DEFAULT_MESSAGE</span></span><div class="tsd-comment tsd-typography"><p>The error message.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InvalidUnsignedPayload.html" class="tsd-signature-type tsd-kind-class">InvalidUnsignedPayload</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L92">src/coinbase/errors.ts:92</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DEFAULT_MESSAGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>DEFAULT_<wbr/>MESSAGE</span><a href="#DEFAULT_MESSAGE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>MESSAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "Invalid unsigned payload"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L85">src/coinbase/errors.ts:85</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_errors.InvalidUnsignedPayload.html" class="tsd-signature-type tsd-kind-class">InvalidUnsignedPayload</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L92">src/coinbase/errors.ts:92</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.message</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1077</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.name</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1076</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1078</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DEFAULT_MESSAGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>DEFAULT_<wbr/>MESSAGE</span><a href="#DEFAULT_MESSAGE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>MESSAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "Invalid unsigned payload"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L85">src/coinbase/errors.ts:85</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p> </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="prepareStackTrace.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">stackTraces</span>: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p> </div><aside class="tsd-sources"><p>Inherited from Error.prepareStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stack<wbr/>Trace<wbr/>Limit</span><a href="#stackTraceLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack<wbr/>Trace<wbr/>Limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Error.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:30</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="captureStackTrace.captureStackTrace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">capture<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetObject</span>, <span class="tsd-kind-parameter">constructorOpt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Error.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:21</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#message" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#DEFAULT_MESSAGE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>MESSAGE</span></a><a href="#prepareStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a><a href="#stackTraceLimit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a><a href="#captureStackTrace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>capture<wbr/>Stack<wbr/>Trace</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_faucet_transaction.FaucetTransaction.html b/docs/classes/coinbase_faucet_transaction.FaucetTransaction.html index 746ffdae..eb09f22f 100644 --- a/docs/classes/coinbase_faucet_transaction.FaucetTransaction.html +++ b/docs/classes/coinbase_faucet_transaction.FaucetTransaction.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FaucetTransaction | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_faucet_transaction.html">coinbase/faucet_transaction</a></li><li><a href="coinbase_faucet_transaction.FaucetTransaction.html">FaucetTransaction</a></li></ul><h1>Class FaucetTransaction</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a transaction from a faucet.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/faucet_transaction.ts#L7">src/coinbase/faucet_transaction.ts:7</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_faucet_transaction.FaucetTransaction.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/faucet_transaction.ts#L7">src/coinbase/faucet_transaction.ts:7</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_faucet_transaction.FaucetTransaction.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_faucet_transaction.FaucetTransaction.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_faucet_transaction.FaucetTransaction.html#getTransactionHash" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Hash</span></a> <a href="coinbase_faucet_transaction.FaucetTransaction.html#getTransactionLink" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Link</span></a> @@ -8,10 +8,10 @@ Do not use this method directly - instead, use Address.faucet().</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">model</span>: <a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a></span><div class="tsd-comment tsd-typography"><p>The FaucetTransaction model.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the model does not exist.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/faucet_transaction.ts#L18">src/coinbase/faucet_transaction.ts:18</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/faucet_transaction.ts#L8">src/coinbase/faucet_transaction.ts:8</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getTransactionHash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction<wbr/>Hash</span><a href="#getTransactionHash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactionHash.getTransactionHash-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction<wbr/>Hash</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getTransactionHash.getTransactionHash-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the transaction hash.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/faucet_transaction.ts#L18">src/coinbase/faucet_transaction.ts:18</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/faucet_transaction.ts#L8">src/coinbase/faucet_transaction.ts:8</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getTransactionHash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction<wbr/>Hash</span><a href="#getTransactionHash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactionHash.getTransactionHash-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction<wbr/>Hash</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getTransactionHash.getTransactionHash-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the transaction hash.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The transaction hash.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/faucet_transaction.ts#L30">src/coinbase/faucet_transaction.ts:30</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransactionLink" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction<wbr/>Link</span><a href="#getTransactionLink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactionLink.getTransactionLink-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction<wbr/>Link</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getTransactionLink.getTransactionLink-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the link to the transaction on the blockchain explorer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/faucet_transaction.ts#L30">src/coinbase/faucet_transaction.ts:30</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransactionLink" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction<wbr/>Link</span><a href="#getTransactionLink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactionLink.getTransactionLink-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction<wbr/>Link</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getTransactionLink.getTransactionLink-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the link to the transaction on the blockchain explorer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The link to the transaction on the blockchain explorer</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/faucet_transaction.ts#L39">src/coinbase/faucet_transaction.ts:39</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the FaucetTransaction.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/faucet_transaction.ts#L39">src/coinbase/faucet_transaction.ts:39</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the FaucetTransaction.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A string representation of the FaucetTransaction.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/faucet_transaction.ts#L48">src/coinbase/faucet_transaction.ts:48</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#getTransactionHash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Hash</span></a><a href="#getTransactionLink" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Link</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/faucet_transaction.ts#L48">src/coinbase/faucet_transaction.ts:48</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#getTransactionHash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Hash</span></a><a href="#getTransactionLink" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Link</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_server_signer.ServerSigner.html b/docs/classes/coinbase_server_signer.ServerSigner.html index 7250ac15..7e4fc9ec 100644 --- a/docs/classes/coinbase_server_signer.ServerSigner.html +++ b/docs/classes/coinbase_server_signer.ServerSigner.html @@ -1,17 +1,17 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerSigner | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_server_signer.html">coinbase/server_signer</a></li><li><a href="coinbase_server_signer.ServerSigner.html">ServerSigner</a></li></ul><h1>Class ServerSigner</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of a Server-Signer. Server-Signers are assigned to sign transactions for a Wallet.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/server_signer.ts#L7">src/coinbase/server_signer.ts:7</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_server_signer.ServerSigner.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/server_signer.ts#L7">src/coinbase/server_signer.ts:7</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_server_signer.ServerSigner.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_server_signer.ServerSigner.html#getId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a> <a href="coinbase_server_signer.ServerSigner.html#getWallets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallets</span></a> <a href="coinbase_server_signer.ServerSigner.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a> <a href="coinbase_server_signer.ServerSigner.html#getDefault" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/server_signer.ts#L8">src/coinbase/server_signer.ts:8</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the ID of the Server-Signer.</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/server_signer.ts#L8">src/coinbase/server_signer.ts:8</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the ID of the Server-Signer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Server-Signer ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/server_signer.ts#L44">src/coinbase/server_signer.ts:44</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWallets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallets</span><a href="#getWallets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWallets.getWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#getWallets.getWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the IDs of the Wallet's the Server-Signer can sign for.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/server_signer.ts#L44">src/coinbase/server_signer.ts:44</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWallets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallets</span><a href="#getWallets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWallets.getWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#getWallets.getWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the IDs of the Wallet's the Server-Signer can sign for.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><p>The Wallet IDs.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/server_signer.ts#L53">src/coinbase/server_signer.ts:53</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the Server-Signer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/server_signer.ts#L53">src/coinbase/server_signer.ts:53</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the Server-Signer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the Server-Signer.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/server_signer.ts#L62">src/coinbase/server_signer.ts:62</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDefault" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Default</span><a href="#getDefault" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDefault.getDefault-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Default</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_server_signer.ServerSigner.html" class="tsd-signature-type tsd-kind-class">ServerSigner</a><span class="tsd-signature-symbol">></span><a href="#getDefault.getDefault-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the default Server-Signer for the CDP Project.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/server_signer.ts#L62">src/coinbase/server_signer.ts:62</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDefault" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Default</span><a href="#getDefault" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDefault.getDefault-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Default</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_server_signer.ServerSigner.html" class="tsd-signature-type tsd-kind-class">ServerSigner</a><span class="tsd-signature-symbol">></span><a href="#getDefault.getDefault-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the default Server-Signer for the CDP Project.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_server_signer.ServerSigner.html" class="tsd-signature-type tsd-kind-class">ServerSigner</a><span class="tsd-signature-symbol">></span></h4><p>The default Server-Signer.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>if the API request to list Server-Signers fails.</p> <h4>Throws</h4><p>if there is no Server-Signer associated with the CDP Project.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/server_signer.ts#L30">src/coinbase/server_signer.ts:30</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#getId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getWallets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallets</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#getDefault" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/server_signer.ts#L30">src/coinbase/server_signer.ts:30</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#getId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getWallets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallets</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#getDefault" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_staking_operation.StakingOperation.html b/docs/classes/coinbase_staking_operation.StakingOperation.html index 76f810ae..c679d233 100644 --- a/docs/classes/coinbase_staking_operation.StakingOperation.html +++ b/docs/classes/coinbase_staking_operation.StakingOperation.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingOperation | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_staking_operation.html">coinbase/staking_operation</a></li><li><a href="coinbase_staking_operation.StakingOperation.html">StakingOperation</a></li></ul><h1>Class StakingOperation</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of a staking operation (stake, unstake, claim rewards, etc). It may have multiple steps with some being transactions to sign, and others to wait.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L14">src/coinbase/staking_operation.ts:14</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_staking_operation.StakingOperation.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L14">src/coinbase/staking_operation.ts:14</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_staking_operation.StakingOperation.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_staking_operation.StakingOperation.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> <a href="coinbase_staking_operation.StakingOperation.html#transactions" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transactions</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_staking_operation.StakingOperation.html#fetch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a> @@ -13,24 +13,24 @@ <a href="coinbase_staking_operation.StakingOperation.html#wait" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wait</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_StakingOperation" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a><a href="#constructor.new_StakingOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a StakingOperation object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">model</span>: <a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a></span><div class="tsd-comment tsd-typography"><p>The staking operation response from the API call.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L24">src/coinbase/staking_operation.ts:24</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L15">src/coinbase/staking_operation.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="transactions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>transactions</span><a href="#transactions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transactions</span><span class="tsd-signature-symbol">:</span> <a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L16">src/coinbase/staking_operation.ts:16</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="fetch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fetch</span><a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetch.fetch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#fetch.fetch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the staking operation for the given ID.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_staking_operation.StakingOperation.html" class="tsd-signature-type tsd-kind-class">StakingOperation</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L24">src/coinbase/staking_operation.ts:24</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L15">src/coinbase/staking_operation.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="transactions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>transactions</span><a href="#transactions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transactions</span><span class="tsd-signature-symbol">:</span> <a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L16">src/coinbase/staking_operation.ts:16</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="fetch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fetch</span><a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetch.fetch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#fetch.fetch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the staking operation for the given ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span></h4><p>The staking operation object.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L128">src/coinbase/staking_operation.ts:128</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getID" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>getID</span><a href="#getID" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getID.getID-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getID</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getID.getID-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the staking operation ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L128">src/coinbase/staking_operation.ts:128</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getID" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>getID</span><a href="#getID" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getID.getID-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getID</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getID.getID-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the staking operation ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The unique ID of the staking operation.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L43">src/coinbase/staking_operation.ts:43</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSignedVoluntaryExitMessages" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Signed<wbr/>Voluntary<wbr/>Exit<wbr/>Messages</span><a href="#getSignedVoluntaryExitMessages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getSignedVoluntaryExitMessages.getSignedVoluntaryExitMessages-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Signed<wbr/>Voluntary<wbr/>Exit<wbr/>Messages</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#getSignedVoluntaryExitMessages.getSignedVoluntaryExitMessages-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get signed voluntary exit messages for native eth unstaking</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L43">src/coinbase/staking_operation.ts:43</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSignedVoluntaryExitMessages" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Signed<wbr/>Voluntary<wbr/>Exit<wbr/>Messages</span><a href="#getSignedVoluntaryExitMessages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getSignedVoluntaryExitMessages.getSignedVoluntaryExitMessages-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Signed<wbr/>Voluntary<wbr/>Exit<wbr/>Messages</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#getSignedVoluntaryExitMessages.getSignedVoluntaryExitMessages-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get signed voluntary exit messages for native eth unstaking</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><p>The signed voluntary exit messages for a native eth unstaking operation.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L61">src/coinbase/staking_operation.ts:61</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Status</span><a href="#getStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStatus.getStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/client_api.StakingOperationStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">StakingOperationStatusEnum</a><a href="#getStatus.getStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the status of the staking operation.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L61">src/coinbase/staking_operation.ts:61</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Status</span><a href="#getStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStatus.getStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/client_api.StakingOperationStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">StakingOperationStatusEnum</a><a href="#getStatus.getStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the status of the staking operation.</p> </div><h4 class="tsd-returns-title">Returns <a href="../types/client_api.StakingOperationStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">StakingOperationStatusEnum</a></h4><p>The status of the staking operation.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L80">src/coinbase/staking_operation.ts:80</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransactions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transactions</span><a href="#getTransactions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactions.getTransactions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transactions</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a><span class="tsd-signature-symbol">[]</span><a href="#getTransactions.getTransactions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the transactions associated with this staking operation.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L80">src/coinbase/staking_operation.ts:80</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransactions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transactions</span><a href="#getTransactions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactions.getTransactions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transactions</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a><span class="tsd-signature-symbol">[]</span><a href="#getTransactions.getTransactions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the transactions associated with this staking operation.</p> </div><h4 class="tsd-returns-title">Returns <a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a><span class="tsd-signature-symbol">[]</span></h4><p>The array of transactions.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L52">src/coinbase/staking_operation.ts:52</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isTerminalState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Terminal<wbr/>State</span><a href="#isTerminalState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isTerminalState.isTerminalState-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Terminal<wbr/>State</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isTerminalState.isTerminalState-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether the Staking operation is in a terminal State.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L52">src/coinbase/staking_operation.ts:52</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isTerminalState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Terminal<wbr/>State</span><a href="#isTerminalState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isTerminalState.isTerminalState-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Terminal<wbr/>State</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isTerminalState.isTerminalState-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether the Staking operation is in a terminal State.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the Staking operation is in a terminal State</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L89">src/coinbase/staking_operation.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sign</span><a href="#sign" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sign.sign-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sign</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#sign.sign-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sign the transactions in the StakingOperation object.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L89">src/coinbase/staking_operation.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sign</span><a href="#sign" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sign.sign-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sign</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#sign.sign-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sign the transactions in the StakingOperation object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">Wallet</span></span><div class="tsd-comment tsd-typography"><p>The key used to sign the transactions.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L151">src/coinbase/staking_operation.ts:151</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="wait" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wait</span><a href="#wait" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="wait.wait-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">wait</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#wait.wait-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Waits until the Staking Operation is completed or failed by polling its status at the given interval.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L151">src/coinbase/staking_operation.ts:151</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="wait" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wait</span><a href="#wait" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="wait.wait-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">wait</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#wait.wait-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Waits until the Staking Operation is completed or failed by polling its status at the given interval.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">intervalSeconds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeoutSeconds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The options to configure the wait function.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">interval<wbr/>Seconds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The interval at which to poll, in seconds</p> </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">timeout<wbr/>Seconds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The maximum amount of time to wait for the StakingOperation to complete, in seconds</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span></h4><p>The completed StakingOperation object.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the StakingOperation takes longer than the given timeout.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L102">src/coinbase/staking_operation.ts:102</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#transactions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transactions</span></a><a href="#fetch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a><a href="#getID" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>getID</span></a><a href="#getSignedVoluntaryExitMessages" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Signed<wbr/>Voluntary<wbr/>Exit<wbr/>Messages</span></a><a href="#getStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Status</span></a><a href="#getTransactions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transactions</span></a><a href="#isTerminalState" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Terminal<wbr/>State</span></a><a href="#sign" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign</span></a><a href="#wait" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wait</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L102">src/coinbase/staking_operation.ts:102</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#transactions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transactions</span></a><a href="#fetch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a><a href="#getID" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>getID</span></a><a href="#getSignedVoluntaryExitMessages" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Signed<wbr/>Voluntary<wbr/>Exit<wbr/>Messages</span></a><a href="#getStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Status</span></a><a href="#getTransactions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transactions</span></a><a href="#isTerminalState" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Terminal<wbr/>State</span></a><a href="#sign" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign</span></a><a href="#wait" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wait</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_staking_reward.StakingReward.html b/docs/classes/coinbase_staking_reward.StakingReward.html index f4439823..21f33f73 100644 --- a/docs/classes/coinbase_staking_reward.StakingReward.html +++ b/docs/classes/coinbase_staking_reward.StakingReward.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingReward | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_staking_reward.html">coinbase/staking_reward</a></li><li><a href="coinbase_staking_reward.StakingReward.html">StakingReward</a></li></ul><h1>Class StakingReward</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of a staking reward earned on a network for a given asset.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_reward.ts#L10">src/coinbase/staking_reward.ts:10</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_staking_reward.StakingReward.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_reward.ts#L10">src/coinbase/staking_reward.ts:10</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_staking_reward.StakingReward.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_staking_reward.StakingReward.html#asset" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset</span></a> <a href="coinbase_staking_reward.StakingReward.html#format" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>format</span></a> <a href="coinbase_staking_reward.StakingReward.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> @@ -12,15 +12,15 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">model</span>: <a href="../interfaces/client_api.StakingReward.html" class="tsd-signature-type tsd-kind-interface">StakingReward</a></span><div class="tsd-comment tsd-typography"><p>The underlying staking reward object.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">asset</span>: <a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a></span><div class="tsd-comment tsd-typography"><p>The asset for the staking reward.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">format</span>: <a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a></span><div class="tsd-comment tsd-typography"><p>The format to return the rewards in. (usd, native). Defaults to usd.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_staking_reward.StakingReward.html" class="tsd-signature-type tsd-kind-class">StakingReward</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_reward.ts#L22">src/coinbase/staking_reward.ts:22</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>asset</span><a href="#asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset</span><span class="tsd-signature-symbol">:</span> <a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_reward.ts#L12">src/coinbase/staking_reward.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="format" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>format</span><a href="#format" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_reward.ts#L13">src/coinbase/staking_reward.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.StakingReward.html" class="tsd-signature-type tsd-kind-interface">StakingReward</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_reward.ts#L11">src/coinbase/staking_reward.ts:11</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="addressId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address<wbr/>Id</span><a href="#addressId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addressId.addressId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">address<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#addressId.addressId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the onchain address of the StakingReward.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_staking_reward.StakingReward.html" class="tsd-signature-type tsd-kind-class">StakingReward</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_reward.ts#L22">src/coinbase/staking_reward.ts:22</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>asset</span><a href="#asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset</span><span class="tsd-signature-symbol">:</span> <a href="coinbase_asset.Asset.html" class="tsd-signature-type tsd-kind-class">Asset</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_reward.ts#L12">src/coinbase/staking_reward.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="format" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>format</span><a href="#format" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_reward.ts#L13">src/coinbase/staking_reward.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.StakingReward.html" class="tsd-signature-type tsd-kind-interface">StakingReward</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_reward.ts#L11">src/coinbase/staking_reward.ts:11</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="addressId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address<wbr/>Id</span><a href="#addressId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addressId.addressId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">address<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#addressId.addressId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the onchain address of the StakingReward.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The onchain address.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_reward.ts#L108">src/coinbase/staking_reward.ts:108</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>amount</span><a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="amount.amount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">amount</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a><a href="#amount.amount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the amount of the StakingReward.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_reward.ts#L108">src/coinbase/staking_reward.ts:108</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>amount</span><a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="amount.amount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">amount</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a><a href="#amount.amount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the amount of the StakingReward.</p> </div><h4 class="tsd-returns-title">Returns <a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></h4><p>The amount.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_reward.ts#L87">src/coinbase/staking_reward.ts:87</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="date" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>date</span><a href="#date" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="date.date-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#date.date-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the date of the StakingReward.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_reward.ts#L87">src/coinbase/staking_reward.ts:87</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="date" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>date</span><a href="#date" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="date.date-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">date</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#date.date-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the date of the StakingReward.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><p>The date.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_reward.ts#L99">src/coinbase/staking_reward.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Print the Staking Reward as a string.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_reward.ts#L99">src/coinbase/staking_reward.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Print the Staking Reward as a string.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The string representation of the Staking Reward.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_reward.ts#L117">src/coinbase/staking_reward.ts:117</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="list" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list</span><a href="#list" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="list.list-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">addressIds</span>, <span class="tsd-kind-parameter">startTime</span>, <span class="tsd-kind-parameter">endTime</span>, <span class="tsd-kind-parameter">format</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_reward.StakingReward.html" class="tsd-signature-type tsd-kind-class">StakingReward</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#list.list-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a list of StakingRewards for the provided network, asset, and addresses.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_reward.ts#L117">src/coinbase/staking_reward.ts:117</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="list" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list</span><a href="#list" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="list.list-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">addressIds</span>, <span class="tsd-kind-parameter">startTime</span>, <span class="tsd-kind-parameter">endTime</span>, <span class="tsd-kind-parameter">format</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_reward.StakingReward.html" class="tsd-signature-type tsd-kind-class">StakingReward</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#list.list-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a list of StakingRewards for the provided network, asset, and addresses.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The network ID.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset ID.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressIds</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The address ID.</p> @@ -28,4 +28,4 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">endTime</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The end time.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">format</span>: <a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a><span class="tsd-signature-symbol"> = StakingRewardFormat.Usd</span></span><div class="tsd-comment tsd-typography"><p>The format to return the rewards in. (usd, native). Defaults to usd.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_staking_reward.StakingReward.html" class="tsd-signature-type tsd-kind-class">StakingReward</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The staking rewards.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_reward.ts#L39">src/coinbase/staking_reward.ts:39</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#asset" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset</span></a><a href="#format" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>format</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#addressId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>address<wbr/>Id</span></a><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>amount</span></a><a href="#date" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>date</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#list" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_reward.ts#L39">src/coinbase/staking_reward.ts:39</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#asset" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset</span></a><a href="#format" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>format</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#addressId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>address<wbr/>Id</span></a><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>amount</span></a><a href="#date" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>date</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#list" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_trade.Trade.html b/docs/classes/coinbase_trade.Trade.html index f096c211..bb2ee705 100644 --- a/docs/classes/coinbase_trade.Trade.html +++ b/docs/classes/coinbase_trade.Trade.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Trade | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_trade.html">coinbase/trade</a></li><li><a href="coinbase_trade.Trade.html">Trade</a></li></ul><h1>Class Trade</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of a Trade, which trades an amount of an Asset to another Asset on a Network. The fee is assumed to be paid in the native Asset of the Network.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L13">src/coinbase/trade.ts:13</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_trade.Trade.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L13">src/coinbase/trade.ts:13</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_trade.Trade.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_trade.Trade.html#approveTransaction" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>approve<wbr/>Transaction?</span></a> <a href="coinbase_trade.Trade.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> <a href="coinbase_trade.Trade.html#transaction" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction?</span></a> @@ -23,33 +23,33 @@ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><ul> <li>If the Trade model is empty.</li> </ul> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L25">src/coinbase/trade.ts:25</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="approveTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>approve<wbr/>Transaction</span><a href="#approveTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">approve<wbr/>Transaction</span><span class="tsd-signature-symbol">?:</span> <a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L16">src/coinbase/trade.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L14">src/coinbase/trade.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>transaction</span><a href="#transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction</span><span class="tsd-signature-symbol">?:</span> <a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L15">src/coinbase/trade.ts:15</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getAddressId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Address<wbr/>Id</span><a href="#getAddressId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAddressId.getAddressId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAddressId.getAddressId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Address ID of the Trade.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L25">src/coinbase/trade.ts:25</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="approveTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>approve<wbr/>Transaction</span><a href="#approveTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">approve<wbr/>Transaction</span><span class="tsd-signature-symbol">?:</span> <a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L16">src/coinbase/trade.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L14">src/coinbase/trade.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>transaction</span><a href="#transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction</span><span class="tsd-signature-symbol">?:</span> <a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L15">src/coinbase/trade.ts:15</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getAddressId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Address<wbr/>Id</span><a href="#getAddressId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAddressId.getAddressId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAddressId.getAddressId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Address ID of the Trade.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Address ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L64">src/coinbase/trade.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getApproveTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Approve<wbr/>Transaction</span><a href="#getApproveTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getApproveTransaction.getApproveTransaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Approve<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a><a href="#getApproveTransaction.getApproveTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the approve transaction if it exists.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L64">src/coinbase/trade.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getApproveTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Approve<wbr/>Transaction</span><a href="#getApproveTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getApproveTransaction.getApproveTransaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Approve<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a><a href="#getApproveTransaction.getApproveTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the approve transaction if it exists.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a></h4><p>The approve transaction.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L121">src/coinbase/trade.ts:121</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFromAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>From<wbr/>Amount</span><a href="#getFromAmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFromAmount.getFromAmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>From<wbr/>Amount</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><a href="#getFromAmount.getFromAmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the amount of the from asset for the Trade.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L121">src/coinbase/trade.ts:121</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFromAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>From<wbr/>Amount</span><a href="#getFromAmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFromAmount.getFromAmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>From<wbr/>Amount</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><a href="#getFromAmount.getFromAmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the amount of the from asset for the Trade.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Decimal</span></h4><p>The amount of the from asset.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L82">src/coinbase/trade.ts:82</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFromAssetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>From<wbr/>Asset<wbr/>Id</span><a href="#getFromAssetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFromAssetId.getFromAssetId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>From<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFromAssetId.getFromAssetId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the From Asset ID of the Trade.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L82">src/coinbase/trade.ts:82</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFromAssetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>From<wbr/>Asset<wbr/>Id</span><a href="#getFromAssetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFromAssetId.getFromAssetId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>From<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFromAssetId.getFromAssetId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the From Asset ID of the Trade.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The From Asset ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L73">src/coinbase/trade.ts:73</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Trade ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L73">src/coinbase/trade.ts:73</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Trade ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Trade ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L37">src/coinbase/trade.ts:37</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getNetworkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Network<wbr/>Id</span><a href="#getNetworkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getNetworkId.getNetworkId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Network<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getNetworkId.getNetworkId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Network ID of the Trade.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L37">src/coinbase/trade.ts:37</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getNetworkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Network<wbr/>Id</span><a href="#getNetworkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getNetworkId.getNetworkId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Network<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getNetworkId.getNetworkId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Network ID of the Trade.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Network ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L46">src/coinbase/trade.ts:46</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Status</span><a href="#getStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStatus.getStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/coinbase_types.TransactionStatus.html" class="tsd-signature-type tsd-kind-enum">TransactionStatus</a><a href="#getStatus.getStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the status of the Trade.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L46">src/coinbase/trade.ts:46</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Status</span><a href="#getStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStatus.getStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/coinbase_types.TransactionStatus.html" class="tsd-signature-type tsd-kind-enum">TransactionStatus</a><a href="#getStatus.getStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the status of the Trade.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/coinbase_types.TransactionStatus.html" class="tsd-signature-type tsd-kind-enum">TransactionStatus</a></h4><p>The status.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L133">src/coinbase/trade.ts:133</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getToAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>To<wbr/>Amount</span><a href="#getToAmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getToAmount.getToAmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>To<wbr/>Amount</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><a href="#getToAmount.getToAmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the amount of the to asset for the Trade.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L133">src/coinbase/trade.ts:133</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getToAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>To<wbr/>Amount</span><a href="#getToAmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getToAmount.getToAmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>To<wbr/>Amount</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><a href="#getToAmount.getToAmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the amount of the to asset for the Trade.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Decimal</span></h4><p>The amount of the to asset.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L101">src/coinbase/trade.ts:101</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getToAssetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>To<wbr/>Asset<wbr/>Id</span><a href="#getToAssetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getToAssetId.getToAssetId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>To<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getToAssetId.getToAssetId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the To Asset ID of the Trade.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L101">src/coinbase/trade.ts:101</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getToAssetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>To<wbr/>Asset<wbr/>Id</span><a href="#getToAssetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getToAssetId.getToAssetId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>To<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getToAssetId.getToAssetId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the To Asset ID of the Trade.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The To Asset ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L92">src/coinbase/trade.ts:92</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction</span><a href="#getTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransaction.getTransaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a><a href="#getTransaction.getTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Trade transaction.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L92">src/coinbase/trade.ts:92</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction</span><a href="#getTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransaction.getTransaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a><a href="#getTransaction.getTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Trade transaction.</p> </div><h4 class="tsd-returns-title">Returns <a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a></h4><p>The Trade transaction.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L111">src/coinbase/trade.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWalletId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet<wbr/>Id</span><a href="#getWalletId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWalletId.getWalletId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getWalletId.getWalletId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Wallet ID of the Trade.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L111">src/coinbase/trade.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWalletId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet<wbr/>Id</span><a href="#getWalletId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWalletId.getWalletId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getWalletId.getWalletId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Wallet ID of the Trade.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Wallet ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L55">src/coinbase/trade.ts:55</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="reload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reload</span><a href="#reload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="reload.reload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span><a href="#reload.reload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reloads the Trade model with the latest version from the server side.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L55">src/coinbase/trade.ts:55</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="reload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reload</span><a href="#reload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="reload.reload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span><a href="#reload.reload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reloads the Trade model with the latest version from the server side.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span></h4><p>The most recent version of Trade from the server.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L168">src/coinbase/trade.ts:168</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the Trade.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L168">src/coinbase/trade.ts:168</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the Trade.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A String representation of the Trade.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L189">src/coinbase/trade.ts:189</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="wait" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wait</span><a href="#wait" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="wait.wait-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">wait</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span><a href="#wait.wait-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Waits until the Trade is completed or failed by polling the Network at the given interval. Raises a +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L189">src/coinbase/trade.ts:189</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="wait" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wait</span><a href="#wait" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="wait.wait-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">wait</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span><a href="#wait.wait-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Waits until the Trade is completed or failed by polling the Network at the given interval. Raises a Error if the Trade takes longer than the given timeout.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">intervalSeconds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeoutSeconds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The options to configure the wait function.</p> </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">interval<wbr/>Seconds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The interval at which to poll the Network, in seconds</p> @@ -57,4 +57,4 @@ </div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span></h4><p>The completed Trade object.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the Trade takes longer than the given timeout.</p> <h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L148">src/coinbase/trade.ts:148</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#approveTransaction" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>approve<wbr/>Transaction</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#transaction" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction</span></a><a href="#getAddressId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address<wbr/>Id</span></a><a href="#getApproveTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Approve<wbr/>Transaction</span></a><a href="#getFromAmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>From<wbr/>Amount</span></a><a href="#getFromAssetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>From<wbr/>Asset<wbr/>Id</span></a><a href="#getId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getNetworkId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Network<wbr/>Id</span></a><a href="#getStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Status</span></a><a href="#getToAmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>To<wbr/>Amount</span></a><a href="#getToAssetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>To<wbr/>Asset<wbr/>Id</span></a><a href="#getTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction</span></a><a href="#getWalletId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet<wbr/>Id</span></a><a href="#reload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reload</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#wait" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wait</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L148">src/coinbase/trade.ts:148</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#approveTransaction" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>approve<wbr/>Transaction</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#transaction" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction</span></a><a href="#getAddressId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address<wbr/>Id</span></a><a href="#getApproveTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Approve<wbr/>Transaction</span></a><a href="#getFromAmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>From<wbr/>Amount</span></a><a href="#getFromAssetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>From<wbr/>Asset<wbr/>Id</span></a><a href="#getId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getNetworkId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Network<wbr/>Id</span></a><a href="#getStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Status</span></a><a href="#getToAmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>To<wbr/>Amount</span></a><a href="#getToAssetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>To<wbr/>Asset<wbr/>Id</span></a><a href="#getTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction</span></a><a href="#getWalletId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet<wbr/>Id</span></a><a href="#reload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reload</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#wait" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wait</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_transaction.Transaction.html b/docs/classes/coinbase_transaction.Transaction.html index 5c15ee5a..bbaedc09 100644 --- a/docs/classes/coinbase_transaction.Transaction.html +++ b/docs/classes/coinbase_transaction.Transaction.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Transaction | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_transaction.html">coinbase/transaction</a></li><li><a href="coinbase_transaction.Transaction.html">Transaction</a></li></ul><h1>Class Transaction</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of an onchain Transaction.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L9">src/coinbase/transaction.ts:9</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_transaction.Transaction.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L9">src/coinbase/transaction.ts:9</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_transaction.Transaction.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_transaction.Transaction.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> <a href="coinbase_transaction.Transaction.html#raw" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>raw?</span></a> <a href="coinbase_transaction.Transaction.html#signed" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed</span></a> @@ -16,28 +16,28 @@ <a href="coinbase_transaction.Transaction.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Transaction" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a><a href="#constructor.new_Transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Transactions should be constructed via higher level abstractions like Trade or Transfer.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">model</span>: <a href="../interfaces/client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a></span><div class="tsd-comment tsd-typography"><p>The underlying Transaction object.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L20">src/coinbase/transaction.ts:20</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L10">src/coinbase/transaction.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="raw" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>raw</span><a href="#raw" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">raw</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Transaction</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L11">src/coinbase/transaction.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="signed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>signed</span><a href="#signed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L12">src/coinbase/transaction.ts:12</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="fromAddressId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Address<wbr/>Id</span><a href="#fromAddressId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromAddressId.fromAddressId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Address<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#fromAddressId.fromAddressId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the From Address ID for the Transaction.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_transaction.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L20">src/coinbase/transaction.ts:20</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L10">src/coinbase/transaction.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="raw" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>raw</span><a href="#raw" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">raw</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Transaction</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L11">src/coinbase/transaction.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="signed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>signed</span><a href="#signed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L12">src/coinbase/transaction.ts:12</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="fromAddressId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Address<wbr/>Id</span><a href="#fromAddressId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromAddressId.fromAddressId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Address<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#fromAddressId.fromAddressId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the From Address ID for the Transaction.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The From Address ID</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L79">src/coinbase/transaction.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSignedPayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Signed<wbr/>Payload</span><a href="#getSignedPayload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getSignedPayload.getSignedPayload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Signed<wbr/>Payload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#getSignedPayload.getSignedPayload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Signed Payload of the Transaction.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L79">src/coinbase/transaction.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSignedPayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Signed<wbr/>Payload</span><a href="#getSignedPayload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getSignedPayload.getSignedPayload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Signed<wbr/>Payload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#getSignedPayload.getSignedPayload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Signed Payload of the Transaction.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><p>The Signed Payload</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L41">src/coinbase/transaction.ts:41</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Status</span><a href="#getStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStatus.getStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/coinbase_types.TransactionStatus.html" class="tsd-signature-type tsd-kind-enum">TransactionStatus</a><a href="#getStatus.getStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Status of the Transaction.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L41">src/coinbase/transaction.ts:41</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Status</span><a href="#getStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStatus.getStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/coinbase_types.TransactionStatus.html" class="tsd-signature-type tsd-kind-enum">TransactionStatus</a><a href="#getStatus.getStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Status of the Transaction.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/coinbase_types.TransactionStatus.html" class="tsd-signature-type tsd-kind-enum">TransactionStatus</a></h4><p>The Status</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L59">src/coinbase/transaction.ts:59</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransactionHash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction<wbr/>Hash</span><a href="#getTransactionHash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactionHash.getTransactionHash-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction<wbr/>Hash</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#getTransactionHash.getTransactionHash-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Transaction Hash of the Transaction.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L59">src/coinbase/transaction.ts:59</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransactionHash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction<wbr/>Hash</span><a href="#getTransactionHash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactionHash.getTransactionHash-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction<wbr/>Hash</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#getTransactionHash.getTransactionHash-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Transaction Hash of the Transaction.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><p>The Transaction Hash</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L50">src/coinbase/transaction.ts:50</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransactionLink" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction<wbr/>Link</span><a href="#getTransactionLink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactionLink.getTransactionLink-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction<wbr/>Link</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getTransactionLink.getTransactionLink-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the link to the Transaction on the blockchain explorer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L50">src/coinbase/transaction.ts:50</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransactionLink" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction<wbr/>Link</span><a href="#getTransactionLink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactionLink.getTransactionLink-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction<wbr/>Link</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getTransactionLink.getTransactionLink-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the link to the Transaction on the blockchain explorer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The link to the Transaction on the blockchain explorer</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L100">src/coinbase/transaction.ts:100</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUnsignedPayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Unsigned<wbr/>Payload</span><a href="#getUnsignedPayload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUnsignedPayload.getUnsignedPayload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Unsigned<wbr/>Payload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getUnsignedPayload.getUnsignedPayload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Unsigned Payload of the Transaction.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L100">src/coinbase/transaction.ts:100</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUnsignedPayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Unsigned<wbr/>Payload</span><a href="#getUnsignedPayload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUnsignedPayload.getUnsignedPayload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Unsigned<wbr/>Payload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getUnsignedPayload.getUnsignedPayload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Unsigned Payload of the Transaction.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Unsigned Payload</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L32">src/coinbase/transaction.ts:32</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isSigned" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Signed</span><a href="#isSigned" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isSigned.isSigned-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Signed</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><a href="#isSigned.isSigned-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether the transaction has been signed.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L32">src/coinbase/transaction.ts:32</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isSigned" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Signed</span><a href="#isSigned" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isSigned.isSigned-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Signed</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><a href="#isSigned.isSigned-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether the transaction has been signed.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h4><p>if the transaction has been signed.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L149">src/coinbase/transaction.ts:149</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isTerminalState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Terminal<wbr/>State</span><a href="#isTerminalState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isTerminalState.isTerminalState-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Terminal<wbr/>State</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isTerminalState.isTerminalState-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether the Transaction is in a terminal State.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L149">src/coinbase/transaction.ts:149</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isTerminalState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Terminal<wbr/>State</span><a href="#isTerminalState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isTerminalState.isTerminalState-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Terminal<wbr/>State</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isTerminalState.isTerminalState-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether the Transaction is in a terminal State.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the Transaction is in a terminal State</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L88">src/coinbase/transaction.ts:88</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rawTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>raw<wbr/>Transaction</span><a href="#rawTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="rawTransaction.rawTransaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">raw<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</span><a href="#rawTransaction.rawTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the underlying raw transaction.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L88">src/coinbase/transaction.ts:88</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rawTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>raw<wbr/>Transaction</span><a href="#rawTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="rawTransaction.rawTransaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">raw<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</span><a href="#rawTransaction.rawTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the underlying raw transaction.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4><p>The ethers.js Transaction object</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the Unsigned Payload is invalid.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L110">src/coinbase/transaction.ts:110</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sign</span><a href="#sign" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sign.sign-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sign</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sign.sign-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Signs the Transaction with the provided key and returns the hex signing payload.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L110">src/coinbase/transaction.ts:110</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sign</span><a href="#sign" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sign.sign-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sign</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sign.sign-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Signs the Transaction with the provided key and returns the hex signing payload.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">Wallet</span></span><div class="tsd-comment tsd-typography"><p>The key to sign the transaction with</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>The hex-encoded signed payload</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L136">src/coinbase/transaction.ts:136</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the Transaction.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L136">src/coinbase/transaction.ts:136</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the Transaction.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A string representation of the Transaction.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L158">src/coinbase/transaction.ts:158</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#raw" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>raw</span></a><a href="#signed" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed</span></a><a href="#fromAddressId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Address<wbr/>Id</span></a><a href="#getSignedPayload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Signed<wbr/>Payload</span></a><a href="#getStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Status</span></a><a href="#getTransactionHash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Hash</span></a><a href="#getTransactionLink" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Link</span></a><a href="#getUnsignedPayload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Unsigned<wbr/>Payload</span></a><a href="#isSigned" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Signed</span></a><a href="#isTerminalState" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Terminal<wbr/>State</span></a><a href="#rawTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>raw<wbr/>Transaction</span></a><a href="#sign" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L158">src/coinbase/transaction.ts:158</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#raw" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>raw</span></a><a href="#signed" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed</span></a><a href="#fromAddressId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Address<wbr/>Id</span></a><a href="#getSignedPayload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Signed<wbr/>Payload</span></a><a href="#getStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Status</span></a><a href="#getTransactionHash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Hash</span></a><a href="#getTransactionLink" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Link</span></a><a href="#getUnsignedPayload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Unsigned<wbr/>Payload</span></a><a href="#isSigned" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Signed</span></a><a href="#isTerminalState" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Terminal<wbr/>State</span></a><a href="#rawTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>raw<wbr/>Transaction</span></a><a href="#sign" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_transfer.Transfer.html b/docs/classes/coinbase_transfer.Transfer.html index 7d7b74de..0364f399 100644 --- a/docs/classes/coinbase_transfer.Transfer.html +++ b/docs/classes/coinbase_transfer.Transfer.html @@ -1,7 +1,7 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Transfer | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_transfer.html">coinbase/transfer</a></li><li><a href="coinbase_transfer.Transfer.html">Transfer</a></li></ul><h1>Class Transfer</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of a Transfer, which moves an Amount of an Asset from a user-controlled Wallet to another Address. The fee is assumed to be paid in the native Asset of the Network.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L14">src/coinbase/transfer.ts:14</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_transfer.Transfer.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L14">src/coinbase/transfer.ts:14</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_transfer.Transfer.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> <a href="coinbase_transfer.Transfer.html#transaction" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction?</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_transfer.Transfer.html#getAmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Amount</span></a> <a href="coinbase_transfer.Transfer.html#getAssetId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Id</span></a> @@ -20,40 +20,40 @@ <a href="coinbase_transfer.Transfer.html#setSignedTransaction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Signed<wbr/>Transaction</span></a> <a href="coinbase_transfer.Transfer.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a> <a href="coinbase_transfer.Transfer.html#fromModel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Model</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L15">src/coinbase/transfer.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>transaction</span><a href="#transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Transaction</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L16">src/coinbase/transfer.ts:16</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Amount</span><a href="#getAmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAmount.getAmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Amount</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><a href="#getAmount.getAmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Amount of the Transfer.</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L15">src/coinbase/transfer.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>transaction</span><a href="#transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Transaction</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L16">src/coinbase/transfer.ts:16</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Amount</span><a href="#getAmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAmount.getAmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Amount</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span><a href="#getAmount.getAmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Amount of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Decimal</span></h4><p>The Amount of the Asset.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L101">src/coinbase/transfer.ts:101</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAssetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Asset<wbr/>Id</span><a href="#getAssetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAssetId.getAssetId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAssetId.getAssetId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Asset ID of the Transfer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L101">src/coinbase/transfer.ts:101</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAssetId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Asset<wbr/>Id</span><a href="#getAssetId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAssetId.getAssetId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getAssetId.getAssetId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Asset ID of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Asset ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L92">src/coinbase/transfer.ts:92</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDestinationAddressId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Destination<wbr/>Address<wbr/>Id</span><a href="#getDestinationAddressId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDestinationAddressId.getDestinationAddressId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Destination<wbr/>Address<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getDestinationAddressId.getDestinationAddressId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Destination Address ID of the Transfer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L92">src/coinbase/transfer.ts:92</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDestinationAddressId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Destination<wbr/>Address<wbr/>Id</span><a href="#getDestinationAddressId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDestinationAddressId.getDestinationAddressId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Destination<wbr/>Address<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getDestinationAddressId.getDestinationAddressId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Destination Address ID of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Destination Address ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L83">src/coinbase/transfer.ts:83</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFromAddressId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>From<wbr/>Address<wbr/>Id</span><a href="#getFromAddressId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFromAddressId.getFromAddressId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>From<wbr/>Address<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFromAddressId.getFromAddressId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the From Address ID of the Transfer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L83">src/coinbase/transfer.ts:83</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFromAddressId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>From<wbr/>Address<wbr/>Id</span><a href="#getFromAddressId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFromAddressId.getFromAddressId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>From<wbr/>Address<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFromAddressId.getFromAddressId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the From Address ID of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The From Address ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L74">src/coinbase/transfer.ts:74</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the ID of the Transfer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L74">src/coinbase/transfer.ts:74</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the ID of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Transfer ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L47">src/coinbase/transfer.ts:47</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getNetworkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Network<wbr/>Id</span><a href="#getNetworkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getNetworkId.getNetworkId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Network<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getNetworkId.getNetworkId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Network ID of the Transfer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L47">src/coinbase/transfer.ts:47</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getNetworkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Network<wbr/>Id</span><a href="#getNetworkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getNetworkId.getNetworkId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Network<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getNetworkId.getNetworkId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Network ID of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Network ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L56">src/coinbase/transfer.ts:56</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSignedPayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Signed<wbr/>Payload</span><a href="#getSignedPayload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getSignedPayload.getSignedPayload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Signed<wbr/>Payload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#getSignedPayload.getSignedPayload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Signed Payload of the Transfer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L56">src/coinbase/transfer.ts:56</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSignedPayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Signed<wbr/>Payload</span><a href="#getSignedPayload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getSignedPayload.getSignedPayload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Signed<wbr/>Payload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#getSignedPayload.getSignedPayload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Signed Payload of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><p>The Signed Payload as a Hex string, or undefined if not yet available.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L120">src/coinbase/transfer.ts:120</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Status</span><a href="#getStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStatus.getStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/coinbase_types.TransferStatus.html" class="tsd-signature-type tsd-kind-enum">TransferStatus</a><a href="#getStatus.getStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Status of the Transfer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L120">src/coinbase/transfer.ts:120</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Status</span><a href="#getStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStatus.getStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/coinbase_types.TransferStatus.html" class="tsd-signature-type tsd-kind-enum">TransferStatus</a><a href="#getStatus.getStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Status of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/coinbase_types.TransferStatus.html" class="tsd-signature-type tsd-kind-enum">TransferStatus</a></h4><p>The Status of the Transfer.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L173">src/coinbase/transfer.ts:173</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction</span><a href="#getTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransaction.getTransaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</span><a href="#getTransaction.getTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Transaction of the Transfer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L173">src/coinbase/transfer.ts:173</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction</span><a href="#getTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransaction.getTransaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</span><a href="#getTransaction.getTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Transaction of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Transaction</span></h4><p>The ethers.js Transaction object.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>(InvalidUnsignedPayload) If the Unsigned Payload is invalid.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L139">src/coinbase/transfer.ts:139</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransactionHash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction<wbr/>Hash</span><a href="#getTransactionHash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactionHash.getTransactionHash-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction<wbr/>Hash</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#getTransactionHash.getTransactionHash-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Transaction Hash of the Transfer.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L139">src/coinbase/transfer.ts:139</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransactionHash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction<wbr/>Hash</span><a href="#getTransactionHash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactionHash.getTransactionHash-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction<wbr/>Hash</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#getTransactionHash.getTransactionHash-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Transaction Hash of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><p>The Transaction Hash as a Hex string, or undefined if not yet available.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L129">src/coinbase/transfer.ts:129</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransactionLink" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction<wbr/>Link</span><a href="#getTransactionLink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactionLink.getTransactionLink-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction<wbr/>Link</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getTransactionLink.getTransactionLink-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the link to the Transaction on the blockchain explorer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L129">src/coinbase/transfer.ts:129</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransactionLink" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transaction<wbr/>Link</span><a href="#getTransactionLink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransactionLink.getTransactionLink-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transaction<wbr/>Link</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getTransactionLink.getTransactionLink-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the link to the Transaction on the blockchain explorer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The link to the Transaction on the blockchain explorer.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L193">src/coinbase/transfer.ts:193</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUnsignedPayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Unsigned<wbr/>Payload</span><a href="#getUnsignedPayload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUnsignedPayload.getUnsignedPayload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Unsigned<wbr/>Payload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getUnsignedPayload.getUnsignedPayload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Unsigned Payload of the Transfer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L193">src/coinbase/transfer.ts:193</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUnsignedPayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Unsigned<wbr/>Payload</span><a href="#getUnsignedPayload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUnsignedPayload.getUnsignedPayload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Unsigned<wbr/>Payload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getUnsignedPayload.getUnsignedPayload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Unsigned Payload of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Unsigned Payload as a Hex string.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L111">src/coinbase/transfer.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWalletId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet<wbr/>Id</span><a href="#getWalletId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWalletId.getWalletId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getWalletId.getWalletId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Wallet ID of the Transfer.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L111">src/coinbase/transfer.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWalletId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet<wbr/>Id</span><a href="#getWalletId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWalletId.getWalletId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getWalletId.getWalletId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Wallet ID of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Wallet ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L65">src/coinbase/transfer.ts:65</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="reload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reload</span><a href="#reload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="reload.reload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#reload.reload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reloads the Transfer model with the latest data from the server.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L65">src/coinbase/transfer.ts:65</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="reload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reload</span><a href="#reload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="reload.reload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#reload.reload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reloads the Transfer model with the latest data from the server.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>if the API request to get a Transfer fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L202">src/coinbase/transfer.ts:202</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setSignedTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Signed<wbr/>Transaction</span><a href="#setSignedTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setSignedTransaction.setSignedTransaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Signed<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">transaction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setSignedTransaction.setSignedTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the Signed Transaction of the Transfer.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L202">src/coinbase/transfer.ts:202</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setSignedTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Signed<wbr/>Transaction</span><a href="#setSignedTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setSignedTransaction.setSignedTransaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Signed<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">transaction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setSignedTransaction.setSignedTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the Signed Transaction of the Transfer.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">transaction</span>: <span class="tsd-signature-type">Transaction</span></span><div class="tsd-comment tsd-typography"><p>The Signed Transaction.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L164">src/coinbase/transfer.ts:164</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the Transfer.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L164">src/coinbase/transfer.ts:164</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the Transfer.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The string representation of the Transfer.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L216">src/coinbase/transfer.ts:216</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromModel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Model</span><a href="#fromModel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromModel.fromModel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Model</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">transferModel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_transfer.Transfer.html" class="tsd-signature-type tsd-kind-class">Transfer</a><a href="#fromModel.fromModel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts a TransferModel into a Transfer object.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L216">src/coinbase/transfer.ts:216</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromModel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Model</span><a href="#fromModel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromModel.fromModel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Model</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">transferModel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_transfer.Transfer.html" class="tsd-signature-type tsd-kind-class">Transfer</a><a href="#fromModel.fromModel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts a TransferModel into a Transfer object.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">transferModel</span>: <a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a></span><div class="tsd-comment tsd-typography"><p>The Transfer model object.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_transfer.Transfer.html" class="tsd-signature-type tsd-kind-class">Transfer</a></h4><p>The Transfer object.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L38">src/coinbase/transfer.ts:38</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#transaction" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction</span></a><a href="#getAmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Amount</span></a><a href="#getAssetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Id</span></a><a href="#getDestinationAddressId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Destination<wbr/>Address<wbr/>Id</span></a><a href="#getFromAddressId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>From<wbr/>Address<wbr/>Id</span></a><a href="#getId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getNetworkId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Network<wbr/>Id</span></a><a href="#getSignedPayload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Signed<wbr/>Payload</span></a><a href="#getStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Status</span></a><a href="#getTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction</span></a><a href="#getTransactionHash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Hash</span></a><a href="#getTransactionLink" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Link</span></a><a href="#getUnsignedPayload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Unsigned<wbr/>Payload</span></a><a href="#getWalletId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet<wbr/>Id</span></a><a href="#reload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reload</span></a><a href="#setSignedTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Signed<wbr/>Transaction</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#fromModel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Model</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L38">src/coinbase/transfer.ts:38</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#transaction" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction</span></a><a href="#getAmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Amount</span></a><a href="#getAssetId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Id</span></a><a href="#getDestinationAddressId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Destination<wbr/>Address<wbr/>Id</span></a><a href="#getFromAddressId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>From<wbr/>Address<wbr/>Id</span></a><a href="#getId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getNetworkId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Network<wbr/>Id</span></a><a href="#getSignedPayload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Signed<wbr/>Payload</span></a><a href="#getStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Status</span></a><a href="#getTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction</span></a><a href="#getTransactionHash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Hash</span></a><a href="#getTransactionLink" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transaction<wbr/>Link</span></a><a href="#getUnsignedPayload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Unsigned<wbr/>Payload</span></a><a href="#getWalletId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet<wbr/>Id</span></a><a href="#reload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reload</span></a><a href="#setSignedTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Signed<wbr/>Transaction</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#fromModel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Model</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_user.User.html b/docs/classes/coinbase_user.User.html index 42881bee..46c3c082 100644 --- a/docs/classes/coinbase_user.User.html +++ b/docs/classes/coinbase_user.User.html @@ -1,7 +1,7 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>User | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_user.html">coinbase/user</a></li><li><a href="coinbase_user.User.html">User</a></li></ul><h1>Class User</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of a User. Users have Wallets, which can hold balances of Assets. Access the default User through Coinbase.defaultUser().</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/user.ts#L14">src/coinbase/user.ts:14</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_user.User.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/user.ts#L14">src/coinbase/user.ts:14</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_user.User.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_user.User.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_user.User.html#createWallet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Wallet</span></a> <a href="coinbase_user.User.html#getId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a> @@ -11,7 +11,7 @@ <a href="coinbase_user.User.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_User" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_user.User.html" class="tsd-signature-type tsd-kind-class">User</a><a href="#constructor.new_User" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new User instance.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a></span><div class="tsd-comment tsd-typography"><p>The user model.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_user.User.html" class="tsd-signature-type tsd-kind-class">User</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/user.ts#L22">src/coinbase/user.ts:22</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/user.ts#L15">src/coinbase/user.ts:15</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="createWallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Wallet</span><a href="#createWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createWallet.createWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createWalletOptions</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span><a href="#createWallet.createWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new Wallet belonging to the User.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_user.User.html" class="tsd-signature-type tsd-kind-class">User</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/user.ts#L22">src/coinbase/user.ts:22</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/user.ts#L15">src/coinbase/user.ts:15</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="createWallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Wallet</span><a href="#createWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createWallet.createWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createWalletOptions</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span><a href="#createWallet.createWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new Wallet belonging to the User.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">createWalletOptions</span>: <span class="tsd-signature-type">CreateWalletOptionsType</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The options for creating the Wallet.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span></h4><p>the new Wallet</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><ul> @@ -23,21 +23,21 @@ <h4>Throws</h4><ul> <h4>Throws</h4><ul> <li>If address derivation or caching fails.</li> </ul> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/user.ts#L36">src/coinbase/user.ts:36</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the user's ID.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/user.ts#L36">src/coinbase/user.ts:36</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the user's ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The user's ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/user.ts#L45">src/coinbase/user.ts:45</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet</span><a href="#getWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWallet.getWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">wallet_id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span><a href="#getWallet.getWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Wallet with the given ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/user.ts#L45">src/coinbase/user.ts:45</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet</span><a href="#getWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWallet.getWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">wallet_id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span><a href="#getWallet.getWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Wallet with the given ID.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">wallet_id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the ID of the Wallet</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span></h4><p>the Wallet with the given ID</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/user.ts#L69">src/coinbase/user.ts:69</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="importWallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>import<wbr/>Wallet</span><a href="#importWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="importWallet.importWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">import<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span><a href="#importWallet.importWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Imports a Wallet belonging to a User.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/user.ts#L69">src/coinbase/user.ts:69</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="importWallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>import<wbr/>Wallet</span><a href="#importWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="importWallet.importWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">import<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span><a href="#importWallet.importWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Imports a Wallet belonging to a User.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/coinbase_types.WalletData.html" class="tsd-signature-type tsd-kind-type-alias">WalletData</a></span><div class="tsd-comment tsd-typography"><p>The Wallet data to import.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span></h4><p>The imported Wallet.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the Wallet ID is not provided.</p> <h4>Throws</h4><p>If the seed is not provided.</p> <h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/user.ts#L86">src/coinbase/user.ts:86</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWallets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Wallets</span><a href="#listWallets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">nextPageToken</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nextPageToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">wallets</span><span class="tsd-signature-symbol">: </span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists the Wallets belonging to the User.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/user.ts#L86">src/coinbase/user.ts:86</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWallets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Wallets</span><a href="#listWallets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">nextPageToken</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nextPageToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">wallets</span><span class="tsd-signature-symbol">: </span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists the Wallets belonging to the User.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pageSize</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></span><div class="tsd-comment tsd-typography"><p>The number of Wallets to return per page. Defaults to 10</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">nextPageToken</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The token for the next page of Wallets</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nextPageToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">wallets</span><span class="tsd-signature-symbol">: </span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><p>An object containing the Wallets and the token for the next page</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/user.ts#L56">src/coinbase/user.ts:56</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the User.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/user.ts#L56">src/coinbase/user.ts:56</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of the User.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The string representation of the User.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/user.ts#L95">src/coinbase/user.ts:95</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#createWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Wallet</span></a><a href="#getId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet</span></a><a href="#importWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import<wbr/>Wallet</span></a><a href="#listWallets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallets</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/user.ts#L95">src/coinbase/user.ts:95</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#createWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Wallet</span></a><a href="#getId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet</span></a><a href="#importWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import<wbr/>Wallet</span></a><a href="#listWallets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallets</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_validator.Validator.html b/docs/classes/coinbase_validator.Validator.html index a2854ab3..43441918 100644 --- a/docs/classes/coinbase_validator.Validator.html +++ b/docs/classes/coinbase_validator.Validator.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Validator | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_validator.html">coinbase/validator</a></li><li><a href="coinbase_validator.Validator.html">Validator</a></li></ul><h1>Class Validator</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of a validator onchain.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/validator.ts#L8">src/coinbase/validator.ts:8</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_validator.Validator.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/validator.ts#L8">src/coinbase/validator.ts:8</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="coinbase_validator.Validator.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_validator.Validator.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="coinbase_validator.Validator.html#getStatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Status</span></a> <a href="coinbase_validator.Validator.html#getValidatorId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Validator<wbr/>Id</span></a> @@ -11,20 +11,20 @@ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_validator.Validator.html" class="tsd-signature-type tsd-kind-class">Validator</a></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><ul> <li>If the Validator model is empty.</li> </ul> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/validator.ts#L18">src/coinbase/validator.ts:18</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/validator.ts#L9">src/coinbase/validator.ts:9</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Status</span><a href="#getStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStatus.getStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getStatus.getStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Validator status.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/validator.ts#L18">src/coinbase/validator.ts:18</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/validator.ts#L9">src/coinbase/validator.ts:9</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Status</span><a href="#getStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStatus.getStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getStatus.getStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Validator status.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Validator status.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/validator.ts#L83">src/coinbase/validator.ts:83</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getValidatorId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Validator<wbr/>Id</span><a href="#getValidatorId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getValidatorId.getValidatorId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Validator<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getValidatorId.getValidatorId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Validator ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/validator.ts#L83">src/coinbase/validator.ts:83</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getValidatorId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Validator<wbr/>Id</span><a href="#getValidatorId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getValidatorId.getValidatorId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Validator<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getValidatorId.getValidatorId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Validator ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The Validator ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/validator.ts#L74">src/coinbase/validator.ts:74</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the string representation of the Validator.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/validator.ts#L74">src/coinbase/validator.ts:74</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the string representation of the Validator.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The string representation of the Validator.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/validator.ts#L92">src/coinbase/validator.ts:92</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fetch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>fetch</span><a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetch.fetch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_validator.Validator.html" class="tsd-signature-type tsd-kind-class">Validator</a><span class="tsd-signature-symbol">></span><a href="#fetch.fetch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the details of a specific validator.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/validator.ts#L92">src/coinbase/validator.ts:92</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fetch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>fetch</span><a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetch.fetch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_validator.Validator.html" class="tsd-signature-type tsd-kind-class">Validator</a><span class="tsd-signature-symbol">></span><a href="#fetch.fetch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the details of a specific validator.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The network ID.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset ID.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique publicly identifiable id of the validator for which to fetch the data.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_validator.Validator.html" class="tsd-signature-type tsd-kind-class">Validator</a><span class="tsd-signature-symbol">></span></h4><p>The requested validator details.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/validator.ts#L63">src/coinbase/validator.ts:63</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="list" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list</span><a href="#list" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="list.list-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_validator.Validator.html" class="tsd-signature-type tsd-kind-class">Validator</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#list.list-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of Validators.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/validator.ts#L63">src/coinbase/validator.ts:63</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="list" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list</span><a href="#list" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="list.list-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_validator.Validator.html" class="tsd-signature-type tsd-kind-class">Validator</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#list.list-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of Validators.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The network ID.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The asset ID.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The status to filter by.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_validator.Validator.html" class="tsd-signature-type tsd-kind-class">Validator</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The list of Validators.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/validator.ts#L34">src/coinbase/validator.ts:34</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#getStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Status</span></a><a href="#getValidatorId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Validator<wbr/>Id</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#fetch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a><a href="#list" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/validator.ts#L34">src/coinbase/validator.ts:34</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#getStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Status</span></a><a href="#getValidatorId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Validator<wbr/>Id</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#fetch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a><a href="#list" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/classes/coinbase_wallet.Wallet.html b/docs/classes/coinbase_wallet.Wallet.html index ee532632..43015dcd 100644 --- a/docs/classes/coinbase_wallet.Wallet.html +++ b/docs/classes/coinbase_wallet.Wallet.html @@ -1,7 +1,7 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Wallet | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_wallet.html">coinbase/wallet</a></li><li><a href="coinbase_wallet.Wallet.html">Wallet</a></li></ul><h1>Class Wallet</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A representation of a Wallet. Wallets come with a single default Address, but can expand to have a set of Addresses, each of which can hold a balance of one or more Assets. Wallets can create new Addresses, list their addresses, list their balances, and transfer Assets to other Addresses. Wallets should be created through User.createWallet or User.importWallet.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L33">src/coinbase/wallet.ts:33</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_wallet.Wallet.html#addressPathPrefix" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address<wbr/>Path<wbr/>Prefix</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L33">src/coinbase/wallet.ts:33</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="coinbase_wallet.Wallet.html#addressPathPrefix" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address<wbr/>Path<wbr/>Prefix</span></a> <a href="coinbase_wallet.Wallet.html#addresses" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>addresses</span></a> <a href="coinbase_wallet.Wallet.html#master" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>master?</span></a> <a href="coinbase_wallet.Wallet.html#model" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> @@ -39,79 +39,77 @@ <a href="coinbase_wallet.Wallet.html#import" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import</span></a> <a href="coinbase_wallet.Wallet.html#init" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init</span></a> <a href="coinbase_wallet.Wallet.html#listWallets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallets</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="addressPathPrefix" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>address<wbr/>Path<wbr/>Prefix</span><a href="#addressPathPrefix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address<wbr/>Path<wbr/>Prefix</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"m/44'/60'/0'/0"</span><span class="tsd-signature-symbol"> = "m/44'/60'/0'/0"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L41">src/coinbase/wallet.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="addresses" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>addresses</span><a href="#addresses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">addresses</span><span class="tsd-signature-symbol">:</span> <a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L39">src/coinbase/wallet.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="master" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>master</span><a href="#master" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">master</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HDKey</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L37">src/coinbase/wallet.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L36">src/coinbase/wallet.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="seed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>seed</span><a href="#seed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">seed</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L38">src/coinbase/wallet.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="MAX_ADDRESSES" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>MAX_<wbr/>ADDRESSES</span><a href="#MAX_ADDRESSES" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">MAX_<wbr/>ADDRESSES</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 20</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L34">src/coinbase/wallet.ts:34</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="buildWalletAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>build<wbr/>Wallet<wbr/>Address</span><a href="#buildWalletAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="buildWalletAddress.buildWalletAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Wallet<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">addressModel</span>, <span class="tsd-kind-parameter">index</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a><a href="#buildWalletAddress.buildWalletAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a WalletAddress object for the given AddressModel.</p> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="addressPathPrefix" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>address<wbr/>Path<wbr/>Prefix</span><a href="#addressPathPrefix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address<wbr/>Path<wbr/>Prefix</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"m/44'/60'/0'/0"</span><span class="tsd-signature-symbol"> = "m/44'/60'/0'/0"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L41">src/coinbase/wallet.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="addresses" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>addresses</span><a href="#addresses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">addresses</span><span class="tsd-signature-symbol">:</span> <a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L39">src/coinbase/wallet.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="master" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>master</span><a href="#master" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">master</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HDKey</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L37">src/coinbase/wallet.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L36">src/coinbase/wallet.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="seed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>seed</span><a href="#seed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">seed</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L38">src/coinbase/wallet.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="MAX_ADDRESSES" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>MAX_<wbr/>ADDRESSES</span><a href="#MAX_ADDRESSES" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">MAX_<wbr/>ADDRESSES</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 20</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L34">src/coinbase/wallet.ts:34</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="buildWalletAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>build<wbr/>Wallet<wbr/>Address</span><a href="#buildWalletAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="buildWalletAddress.buildWalletAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Wallet<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">addressModel</span>, <span class="tsd-kind-parameter">index</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a><a href="#buildWalletAddress.buildWalletAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a WalletAddress object for the given AddressModel.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">addressModel</span>: <a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a></span><div class="tsd-comment tsd-typography"><p>The AddressModel to build the WalletAddress from.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The index of the AddressModel.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a></h4><p>The WalletAddress object.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L602">src/coinbase/wallet.ts:602</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="canSign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>can<wbr/>Sign</span><a href="#canSign" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="canSign.canSign-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">can<wbr/>Sign</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#canSign.canSign-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether the Wallet has a seed with which to derive keys and sign transactions.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L617">src/coinbase/wallet.ts:617</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="canSign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>can<wbr/>Sign</span><a href="#canSign" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="canSign.canSign-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">can<wbr/>Sign</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#canSign.canSign-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether the Wallet has a seed with which to derive keys and sign transactions.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the Wallet has a seed with which to derive keys and sign transactions.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L469">src/coinbase/wallet.ts:469</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Address</span><a href="#createAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createAddress.createAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a><span class="tsd-signature-symbol">></span><a href="#createAddress.createAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new Address in the Wallet.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L484">src/coinbase/wallet.ts:484</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Address</span><a href="#createAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createAddress.createAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a><span class="tsd-signature-symbol">></span><a href="#createAddress.createAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new Address in the Wallet.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a><span class="tsd-signature-symbol">></span></h4><p>The new Address.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><ul> <li>If the address creation fails.</li> </ul> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L190">src/coinbase/wallet.ts:190</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="createAttestation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>create<wbr/>Attestation</span><a href="#createAttestation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="createAttestation.createAttestation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Attestation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#createAttestation.createAttestation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates an attestation for the Address currently being created.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L190">src/coinbase/wallet.ts:190</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="createAttestation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>create<wbr/>Attestation</span><a href="#createAttestation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="createAttestation.createAttestation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Attestation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#createAttestation.createAttestation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates an attestation for the Address currently being created.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">HDKey</span></span><div class="tsd-comment tsd-typography"><p>The key of the Wallet.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The attestation.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L687">src/coinbase/wallet.ts:687</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Trade</span><a href="#createTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</span>, <span class="tsd-kind-parameter">fromAssetId</span>, <span class="tsd-kind-parameter">toAssetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span><a href="#createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Trades the given amount of the given Asset for another Asset. Currently only the default address is used to source the Trade</p> -</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">amount</span>: <a href="../types/coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></span><div class="tsd-comment tsd-typography"><p>The amount of the Asset to send.</p> -</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fromAssetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the Asset to trade from.</p> -</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">toAssetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the Asset to trade to.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L702">src/coinbase/wallet.ts:702</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Trade</span><a href="#createTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span><a href="#createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Trades the given amount of the given Asset for another Asset. Currently only the default address is used to source the Trade</p> +</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/coinbase_types.CreateTradeOptions.html" class="tsd-signature-type tsd-kind-type-alias">CreateTradeOptions</a></span><div class="tsd-comment tsd-typography"><p>The options to create the Trade.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_trade.Trade.html" class="tsd-signature-type tsd-kind-class">Trade</a><span class="tsd-signature-symbol">></span></h4><p>The Trade object.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the default address is not found.</p> <h4>Throws</h4><p>If the private key is not loaded, or if the asset IDs are unsupported, or if there are insufficient funds.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L285">src/coinbase/wallet.ts:285</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Transfer</span><a href="#createTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_transfer.Transfer.html" class="tsd-signature-type tsd-kind-class">Transfer</a><span class="tsd-signature-symbol">></span><a href="#createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Transfers the given amount of the given Asset to the given address. Only same-Network Transfers are supported. +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L288">src/coinbase/wallet.ts:288</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Transfer</span><a href="#createTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_transfer.Transfer.html" class="tsd-signature-type tsd-kind-class">Transfer</a><span class="tsd-signature-symbol">></span><a href="#createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Transfers the given amount of the given Asset to the given address. Only same-Network Transfers are supported. Currently only the default_address is used to source the Transfer.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/coinbase_types.CreateTransferOptions.html" class="tsd-signature-type tsd-kind-type-alias">CreateTransferOptions</a></span><div class="tsd-comment tsd-typography"><p>The options to create the Transfer.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_transfer.Transfer.html" class="tsd-signature-type tsd-kind-class">Transfer</a><span class="tsd-signature-symbol">></span></h4><p>The hash of the Transfer transaction.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>if the API request to create a Transfer fails.</p> <h4>Throws</h4><p>if the API request to broadcast a Transfer fails.</p> <h4>Throws</h4><p>if the Transfer times out.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L504">src/coinbase/wallet.ts:504</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="deriveKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>derive<wbr/>Key</span><a href="#deriveKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="deriveKey.deriveKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">derive<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HDKey</span><a href="#deriveKey.deriveKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Derives a key for an already registered Address in the Wallet.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L519">src/coinbase/wallet.ts:519</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="deriveKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>derive<wbr/>Key</span><a href="#deriveKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="deriveKey.deriveKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">derive<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HDKey</span><a href="#deriveKey.deriveKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Derives a key for an already registered Address in the Wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The index of the Address to derive.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HDKey</span></h4><p>The derived key.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><ul> <li>If the key derivation fails.</li> </ul> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L665">src/coinbase/wallet.ts:665</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="export" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>export</span><a href="#export" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="export.export-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">export</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/coinbase_types.WalletData.html" class="tsd-signature-type tsd-kind-type-alias">WalletData</a><a href="#export.export-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Exports the Wallet's data to a WalletData object.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L680">src/coinbase/wallet.ts:680</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="export" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>export</span><a href="#export" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="export.export-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">export</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/coinbase_types.WalletData.html" class="tsd-signature-type tsd-kind-type-alias">WalletData</a><a href="#export.export-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Exports the Wallet's data to a WalletData object.</p> </div><h4 class="tsd-returns-title">Returns <a href="../types/coinbase_types.WalletData.html" class="tsd-signature-type tsd-kind-type-alias">WalletData</a></h4><p>The Wallet's data.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><ul> <li>If the request fails.</li> </ul> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L177">src/coinbase/wallet.ts:177</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="faucet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>faucet</span><a href="#faucet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="faucet.faucet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">faucet</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#faucet.faucet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests funds from the faucet for the Wallet's default address and returns the faucet transaction. +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L177">src/coinbase/wallet.ts:177</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="faucet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>faucet</span><a href="#faucet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="faucet.faucet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">faucet</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#faucet.faucet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests funds from the faucet for the Wallet's default address and returns the faucet transaction. This is only supported on testnet networks.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-signature-type tsd-kind-class">FaucetTransaction</a><span class="tsd-signature-symbol">></span></h4><p>The successful faucet transaction</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the default address is not found.</p> <h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L481">src/coinbase/wallet.ts:481</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Address</span><a href="#getAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAddress.getAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">addressId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a><a href="#getAddress.getAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Address with the given ID.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L496">src/coinbase/wallet.ts:496</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Address</span><a href="#getAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAddress.getAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">addressId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a><a href="#getAddress.getAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Address with the given ID.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the Address to retrieve.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a></h4><p>The Address.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L251">src/coinbase/wallet.ts:251</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Balance</span><a href="#getBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getBalance.getBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#getBalance.getBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the balance of the provided Asset. Balances are aggregated across all Addresses in the Wallet.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L251">src/coinbase/wallet.ts:251</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Balance</span><a href="#getBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getBalance.getBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span><a href="#getBalance.getBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the balance of the provided Asset. Balances are aggregated across all Addresses in the Wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the Asset to retrieve the balance for.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">></span></h4><p>The balance of the Asset.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L308">src/coinbase/wallet.ts:308</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDefaultAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Default<wbr/>Address</span><a href="#getDefaultAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDefaultAddress.getDefaultAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Default<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a><a href="#getDefaultAddress.getDefaultAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the default address of the Wallet.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L323">src/coinbase/wallet.ts:323</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDefaultAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Default<wbr/>Address</span><a href="#getDefaultAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDefaultAddress.getDefaultAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Default<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a><a href="#getDefaultAddress.getDefaultAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the default address of the Wallet.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a></h4><p>The default address</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L458">src/coinbase/wallet.ts:458</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getEncryptionKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Encryption<wbr/>Key</span><a href="#getEncryptionKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getEncryptionKey.getEncryptionKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Encryption<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><a href="#getEncryptionKey.getEncryptionKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the key for encrypting seed data.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L473">src/coinbase/wallet.ts:473</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getEncryptionKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Encryption<wbr/>Key</span><a href="#getEncryptionKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getEncryptionKey.getEncryptionKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Encryption<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><a href="#getEncryptionKey.getEncryptionKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the key for encrypting seed data.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4><p>The encryption key.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L585">src/coinbase/wallet.ts:585</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getExistingSeeds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Existing<wbr/>Seeds</span><a href="#getExistingSeeds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getExistingSeeds.getExistingSeeds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Existing<wbr/>Seeds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../types/coinbase_types.SeedData.html" class="tsd-signature-type tsd-kind-type-alias">SeedData</a><span class="tsd-signature-symbol">></span><a href="#getExistingSeeds.getExistingSeeds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Loads the seed data from the given file.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L600">src/coinbase/wallet.ts:600</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getExistingSeeds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Existing<wbr/>Seeds</span><a href="#getExistingSeeds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="getExistingSeeds.getExistingSeeds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Existing<wbr/>Seeds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../types/coinbase_types.SeedData.html" class="tsd-signature-type tsd-kind-type-alias">SeedData</a><span class="tsd-signature-symbol">></span><a href="#getExistingSeeds.getExistingSeeds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Loads the seed data from the given file.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path of the file to load the seed data from</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../types/coinbase_types.SeedData.html" class="tsd-signature-type tsd-kind-type-alias">SeedData</a><span class="tsd-signature-symbol">></span></h4><p>The seed data</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L549">src/coinbase/wallet.ts:549</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the wallet ID.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L564">src/coinbase/wallet.ts:564</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id</span><a href="#getId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getId.getId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#getId.getId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the wallet ID.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><p>The wallet ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L348">src/coinbase/wallet.ts:348</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getNetworkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Network<wbr/>Id</span><a href="#getNetworkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getNetworkId.getNetworkId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Network<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getNetworkId.getNetworkId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Network ID of the Wallet.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L363">src/coinbase/wallet.ts:363</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getNetworkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Network<wbr/>Id</span><a href="#getNetworkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getNetworkId.getNetworkId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Network<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getNetworkId.getNetworkId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the Network ID of the Wallet.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The network ID.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L325">src/coinbase/wallet.ts:325</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getServerSignerStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Server<wbr/>Signer<wbr/>Status</span><a href="#getServerSignerStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getServerSignerStatus.getServerSignerStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Server<wbr/>Signer<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/coinbase_types.ServerSignerStatus.html" class="tsd-signature-type tsd-kind-enum">ServerSignerStatus</a><a href="#getServerSignerStatus.getServerSignerStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the ServerSigner Status of the Wallet.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L340">src/coinbase/wallet.ts:340</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getServerSignerStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Server<wbr/>Signer<wbr/>Status</span><a href="#getServerSignerStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getServerSignerStatus.getServerSignerStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Server<wbr/>Signer<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/coinbase_types.ServerSignerStatus.html" class="tsd-signature-type tsd-kind-enum">ServerSignerStatus</a><a href="#getServerSignerStatus.getServerSignerStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the ServerSigner Status of the Wallet.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/coinbase_types.ServerSignerStatus.html" class="tsd-signature-type tsd-kind-enum">ServerSignerStatus</a></h4><p>the ServerSigner Status.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L334">src/coinbase/wallet.ts:334</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listAddresses" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Addresses</span><a href="#listAddresses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listAddresses.listAddresses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Addresses</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listAddresses.listAddresses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of Addresses in the Wallet.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L349">src/coinbase/wallet.ts:349</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listAddresses" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Addresses</span><a href="#listAddresses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listAddresses.listAddresses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Addresses</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listAddresses.listAddresses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of Addresses in the Wallet.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_address_wallet_address.WalletAddress.html" class="tsd-signature-type tsd-kind-class">WalletAddress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The list of Addresses.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L262">src/coinbase/wallet.ts:262</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Balances</span><a href="#listBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listBalances.listBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><span class="tsd-signature-symbol">></span><a href="#listBalances.listBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of balances of this Wallet. Balances are aggregated across all Addresses in the Wallet.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L262">src/coinbase/wallet.ts:262</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Balances</span><a href="#listBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listBalances.listBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><span class="tsd-signature-symbol">></span><a href="#listBalances.listBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of balances of this Wallet. Balances are aggregated across all Addresses in the Wallet.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_balance_map.BalanceMap.html" class="tsd-signature-type tsd-kind-class">BalanceMap</a><span class="tsd-signature-symbol">></span></h4><p>The list of balances. The key is the Asset ID, and the value is the balance.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L297">src/coinbase/wallet.ts:297</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>load<wbr/>Seed</span><a href="#loadSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loadSeed.loadSeed-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>Seed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#loadSeed.loadSeed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Loads the seed of the Wallet from the given file.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L312">src/coinbase/wallet.ts:312</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>load<wbr/>Seed</span><a href="#loadSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loadSeed.loadSeed-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>Seed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#loadSeed.loadSeed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Loads the seed of the Wallet from the given file.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path of the file to load the seed from</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>A string indicating the success of the operation</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L406">src/coinbase/wallet.ts:406</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="reload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>reload</span><a href="#reload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="reload.reload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#reload.reload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reloads the Wallet model with the latest data from the server.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L421">src/coinbase/wallet.ts:421</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="reload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>reload</span><a href="#reload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="reload.reload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#reload.reload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reloads the Wallet model with the latest data from the server.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>if the API request to get a Wallet fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L718">src/coinbase/wallet.ts:718</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>Seed</span><a href="#saveSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="saveSeed.saveSeed-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Seed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span>, <span class="tsd-kind-parameter">encrypt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#saveSeed.saveSeed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Saves the seed of the Wallet to the given file. Wallets whose seeds are saved this way can be +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L733">src/coinbase/wallet.ts:733</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>Seed</span><a href="#saveSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="saveSeed.saveSeed-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Seed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span>, <span class="tsd-kind-parameter">encrypt</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#saveSeed.saveSeed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Saves the seed of the Wallet to the given file. Wallets whose seeds are saved this way can be rehydrated using load_seed. A single file can be used for multiple Wallet seeds. This is an insecure method of storing Wallet seeds and should only be used for development purposes.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path of the file to save the seed to</p> @@ -119,24 +117,24 @@ <h4>Throws</h4><p>If the request fails.</p> encrypted or not. Data is unencrypted by default.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A string indicating the success of the operation</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the Wallet does not have a seed</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L363">src/coinbase/wallet.ts:363</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="setMasterNode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>set<wbr/>Master<wbr/>Node</span><a href="#setMasterNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="setMasterNode.setMasterNode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Master<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seed</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HDKey</span><a href="#setMasterNode.setMasterNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the master node for the given seed, if valid. If the seed is undefined it will set the master node using a random seed.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L378">src/coinbase/wallet.ts:378</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="setMasterNode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>set<wbr/>Master<wbr/>Node</span><a href="#setMasterNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="setMasterNode.setMasterNode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Master<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seed</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HDKey</span><a href="#setMasterNode.setMasterNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the master node for the given seed, if valid. If the seed is undefined it will set the master node using a random seed.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">seed</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The seed to use for the Wallet.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HDKey</span></h4><p>The master node for the given seed.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L646">src/coinbase/wallet.ts:646</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Seed</span><a href="#setSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setSeed.setSeed-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Seed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seed</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setSeed.setSeed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the seed for the Wallet.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L661">src/coinbase/wallet.ts:661</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Seed</span><a href="#setSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setSeed.setSeed-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Seed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seed</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setSeed.setSeed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the seed for the Wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">seed</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The seed to use for the Wallet. Expects a 32-byte hexadecimal with no 0x prefix.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the seed is empty.</p> <h4>Throws</h4><p>If the seed is already set.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L220">src/coinbase/wallet.ts:220</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the Wallet.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L220">src/coinbase/wallet.ts:220</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a String representation of the Wallet.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>a String representation of the Wallet</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L528">src/coinbase/wallet.ts:528</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="validateSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Seed</span><a href="#validateSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="validateSeed.validateSeed-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Seed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seed</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#validateSeed.validateSeed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Validates the seed and address models passed to the constructor.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L543">src/coinbase/wallet.ts:543</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="validateSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Seed</span><a href="#validateSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="validateSeed.validateSeed-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Seed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seed</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#validateSeed.validateSeed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Validates the seed and address models passed to the constructor.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">seed</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The seed to use for the Wallet</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L537">src/coinbase/wallet.ts:537</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="waitForSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>wait<wbr/>For<wbr/>Signer</span><a href="#waitForSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="waitForSigner.waitForSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">wait<wbr/>For<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">intervalSeconds</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">timeoutSeconds</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#waitForSigner.waitForSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Waits until the ServerSigner has created a seed for the Wallet.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L552">src/coinbase/wallet.ts:552</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="waitForSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>wait<wbr/>For<wbr/>Signer</span><a href="#waitForSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="waitForSigner.waitForSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">wait<wbr/>For<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">intervalSeconds</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">timeoutSeconds</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#waitForSigner.waitForSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Waits until the ServerSigner has created a seed for the Wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the Wallet that is awaiting seed creation.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">intervalSeconds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.2</span></span><div class="tsd-comment tsd-typography"><p>The interval at which to poll the CDPService, in seconds.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">timeoutSeconds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 20</span></span><div class="tsd-comment tsd-typography"><p>The maximum amount of time to wait for the ServerSigner to create a seed, in seconds.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>if the API request to get a Wallet fails.</p> <h4>Throws</h4><p>if the ServerSigner times out.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L624">src/coinbase/wallet.ts:624</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="create" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>create</span><a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="create.create-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span><a href="#create.create-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a newly created Wallet object. Do not use this method directly. +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L639">src/coinbase/wallet.ts:639</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="create" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>create</span><a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="create.create-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span><a href="#create.create-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a newly created Wallet object. Do not use this method directly. Instead, use User.createWallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/coinbase_types.WalletCreateOptions.html" class="tsd-signature-type tsd-kind-type-alias">WalletCreateOptions</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The options to create the Wallet.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves with the new Wallet object.</p> @@ -148,17 +146,17 @@ <h4>Throws</h4><ul> <h4>Throws</h4><ul> <li>If the request fails.</li> </ul> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L129">src/coinbase/wallet.ts:129</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fetch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>fetch</span><a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetch.fetch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">wallet_id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span><a href="#fetch.fetch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetches a Wallet by its ID. The returned wallet can be immediately used for signing operations if backed by a server signer. +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L129">src/coinbase/wallet.ts:129</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fetch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>fetch</span><a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetch.fetch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">wallet_id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span><a href="#fetch.fetch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetches a Wallet by its ID. The returned wallet can be immediately used for signing operations if backed by a server signer. If the wallet is not backed by a server signer, the wallet's seed will need to be set before it can be used for signing operations.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">wallet_id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the Wallet to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span></h4><p>The fetched Wallet</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L87">src/coinbase/wallet.ts:87</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="import" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>import</span><a href="#import" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="import.import-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">import</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span><a href="#import.import-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Imports a Wallet for the given Wallet data.</p> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L87">src/coinbase/wallet.ts:87</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="import" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>import</span><a href="#import" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="import.import-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">import</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span><a href="#import.import-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Imports a Wallet for the given Wallet data.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/coinbase_types.WalletData.html" class="tsd-signature-type tsd-kind-type-alias">WalletData</a></span><div class="tsd-comment tsd-typography"><p>The Wallet data to import.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">></span></h4><p>The imported Wallet.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the Wallet ID is not provided.</p> <h4>Throws</h4><p>If the seed is not provided.</p> <h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L103">src/coinbase/wallet.ts:103</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="init" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>init</span><a href="#init" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="init.init-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">init</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span>, <span class="tsd-kind-parameter">seed</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><a href="#init.init-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new Wallet object. Do not use this method directly. Instead, use User.createWallet or User.importWallet.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L103">src/coinbase/wallet.ts:103</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="init" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>init</span><a href="#init" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="init.init-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">init</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span>, <span class="tsd-kind-parameter">seed</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><a href="#init.init-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new Wallet object. Do not use this method directly. Instead, use User.createWallet or User.importWallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">model</span>: <a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a></span><div class="tsd-comment tsd-typography"><p>The underlying Wallet model object</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">seed</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The seed to use for the Wallet. Expects a 32-byte hexadecimal with no 0x prefix. If null or undefined, a new seed will be generated. If the empty string, no seed is generated, and the Wallet will be instantiated without a seed and its corresponding private keys.</p> @@ -171,8 +169,8 @@ <h4>Throws</h4><ul> <h4>Throws</h4><ul> <li>If the request fails.</li> </ul> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L162">src/coinbase/wallet.ts:162</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWallets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Wallets</span><a href="#listWallets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">nextPageToken</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nextPageToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">wallets</span><span class="tsd-signature-symbol">: </span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists the Wallets belonging to the User.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L162">src/coinbase/wallet.ts:162</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWallets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Wallets</span><a href="#listWallets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">nextPageToken</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nextPageToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">wallets</span><span class="tsd-signature-symbol">: </span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists the Wallets belonging to the User.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pageSize</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></span><div class="tsd-comment tsd-typography"><p>The number of Wallets to return per page. Defaults to 10</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">nextPageToken</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The token for the next page of Wallets</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">nextPageToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">wallets</span><span class="tsd-signature-symbol">: </span><a href="coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><p>An object containing the Wallets and the token for the next page</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L65">src/coinbase/wallet.ts:65</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#addressPathPrefix" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address<wbr/>Path<wbr/>Prefix</span></a><a href="#addresses" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>addresses</span></a><a href="#master" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>master</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#seed" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>seed</span></a><a href="#MAX_ADDRESSES" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>MAX_<wbr/>ADDRESSES</span></a><a href="#buildWalletAddress" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Wallet<wbr/>Address</span></a><a href="#canSign" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Sign</span></a><a href="#createAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Address</span></a><a href="#createAttestation" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Attestation</span></a><a href="#createTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Trade</span></a><a href="#createTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Transfer</span></a><a href="#deriveKey" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>derive<wbr/>Key</span></a><a href="#export" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export</span></a><a href="#faucet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>faucet</span></a><a href="#getAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address</span></a><a href="#getBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Balance</span></a><a href="#getDefaultAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default<wbr/>Address</span></a><a href="#getEncryptionKey" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Encryption<wbr/>Key</span></a><a href="#getExistingSeeds" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Existing<wbr/>Seeds</span></a><a href="#getId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getNetworkId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Network<wbr/>Id</span></a><a href="#getServerSignerStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Server<wbr/>Signer<wbr/>Status</span></a><a href="#listAddresses" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Addresses</span></a><a href="#listBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Balances</span></a><a href="#loadSeed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Seed</span></a><a href="#reload" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reload</span></a><a href="#saveSeed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Seed</span></a><a href="#setMasterNode" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Master<wbr/>Node</span></a><a href="#setSeed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Seed</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#validateSeed" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Seed</span></a><a href="#waitForSigner" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wait<wbr/>For<wbr/>Signer</span></a><a href="#create" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a><a href="#fetch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a><a href="#import" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import</span></a><a href="#init" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init</span></a><a href="#listWallets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallets</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L65">src/coinbase/wallet.ts:65</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#addressPathPrefix" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address<wbr/>Path<wbr/>Prefix</span></a><a href="#addresses" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>addresses</span></a><a href="#master" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>master</span></a><a href="#model" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#seed" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>seed</span></a><a href="#MAX_ADDRESSES" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>MAX_<wbr/>ADDRESSES</span></a><a href="#buildWalletAddress" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Wallet<wbr/>Address</span></a><a href="#canSign" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Sign</span></a><a href="#createAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Address</span></a><a href="#createAttestation" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Attestation</span></a><a href="#createTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Trade</span></a><a href="#createTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Transfer</span></a><a href="#deriveKey" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>derive<wbr/>Key</span></a><a href="#export" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export</span></a><a href="#faucet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>faucet</span></a><a href="#getAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address</span></a><a href="#getBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Balance</span></a><a href="#getDefaultAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default<wbr/>Address</span></a><a href="#getEncryptionKey" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Encryption<wbr/>Key</span></a><a href="#getExistingSeeds" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Existing<wbr/>Seeds</span></a><a href="#getId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id</span></a><a href="#getNetworkId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Network<wbr/>Id</span></a><a href="#getServerSignerStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Server<wbr/>Signer<wbr/>Status</span></a><a href="#listAddresses" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Addresses</span></a><a href="#listBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Balances</span></a><a href="#loadSeed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Seed</span></a><a href="#reload" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reload</span></a><a href="#saveSeed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Seed</span></a><a href="#setMasterNode" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Master<wbr/>Node</span></a><a href="#setSeed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Seed</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#validateSeed" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Seed</span></a><a href="#waitForSigner" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wait<wbr/>For<wbr/>Signer</span></a><a href="#create" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a><a href="#fetch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a><a href="#import" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import</span></a><a href="#init" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init</span></a><a href="#listWallets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallets</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/enums/client_api.Feature.html b/docs/enums/client_api.Feature.html index 58820f1f..f412a08c 100644 --- a/docs/enums/client_api.Feature.html +++ b/docs/enums/client_api.Feature.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Feature | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.Feature.html">Feature</a></li></ul><h1>Enumeration Feature</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Features that can be enabled for a wallet</p> -</div><div class="tsd-comment tsd-typography"><h4>Export</h4></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L456">src/client/api.ts:456</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L463">src/client/api.ts:463</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="client_api.Feature.html#Faucet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Faucet</span></a> +</div><div class="tsd-comment tsd-typography"><h4>Export</h4></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L456">src/client/api.ts:456</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L463">src/client/api.ts:463</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="client_api.Feature.html#Faucet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Faucet</span></a> <a href="client_api.Feature.html#ServerSigner" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Server<wbr/>Signer</span></a> <a href="client_api.Feature.html#Trade" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Trade</span></a> <a href="client_api.Feature.html#Transfer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Transfer</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Faucet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Faucet</span><a href="#Faucet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Faucet</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"faucet"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L459">src/client/api.ts:459</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ServerSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Server<wbr/>Signer</span><a href="#ServerSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Server<wbr/>Signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"server_signer"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L460">src/client/api.ts:460</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Trade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Trade</span><a href="#Trade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Trade</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"trade"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L458">src/client/api.ts:458</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Transfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Transfer</span><a href="#Transfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Transfer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"transfer"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L457">src/client/api.ts:457</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#Faucet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Faucet</span></a><a href="#ServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Server<wbr/>Signer</span></a><a href="#Trade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Trade</span></a><a href="#Transfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Transfer</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Faucet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Faucet</span><a href="#Faucet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Faucet</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"faucet"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L459">src/client/api.ts:459</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ServerSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Server<wbr/>Signer</span><a href="#ServerSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Server<wbr/>Signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"server_signer"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L460">src/client/api.ts:460</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Trade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Trade</span><a href="#Trade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Trade</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"trade"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L458">src/client/api.ts:458</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Transfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Transfer</span><a href="#Transfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Transfer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"transfer"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L457">src/client/api.ts:457</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#Faucet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Faucet</span></a><a href="#ServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Server<wbr/>Signer</span></a><a href="#Trade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Trade</span></a><a href="#Transfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Transfer</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/enums/client_api.StakingRewardFormat.html b/docs/enums/client_api.StakingRewardFormat.html index a1847487..424a0e54 100644 --- a/docs/enums/client_api.StakingRewardFormat.html +++ b/docs/enums/client_api.StakingRewardFormat.html @@ -1,4 +1,4 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingRewardFormat | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingRewardFormat.html">StakingRewardFormat</a></li></ul><h1>Enumeration StakingRewardFormat</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The format in which the rewards are to be fetched i.e native or in equivalent USD</p> -</div><div class="tsd-comment tsd-typography"><h4>Export</h4></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1054">src/client/api.ts:1054</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1059">src/client/api.ts:1059</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="client_api.StakingRewardFormat.html#Native" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Native</span></a> +</div><div class="tsd-comment tsd-typography"><h4>Export</h4></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1054">src/client/api.ts:1054</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1059">src/client/api.ts:1059</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="client_api.StakingRewardFormat.html#Native" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Native</span></a> <a href="client_api.StakingRewardFormat.html#Usd" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Usd</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Native" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Native</span><a href="#Native" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Native</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"native"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1056">src/client/api.ts:1056</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Usd" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Usd</span><a href="#Usd" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Usd</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"usd"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1055">src/client/api.ts:1055</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#Native" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Native</span></a><a href="#Usd" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Usd</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Native" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Native</span><a href="#Native" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Native</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"native"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1056">src/client/api.ts:1056</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Usd" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Usd</span><a href="#Usd" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Usd</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"usd"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1055">src/client/api.ts:1055</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#Native" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Native</span></a><a href="#Usd" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Usd</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/enums/client_api.TransactionType.html b/docs/enums/client_api.TransactionType.html index e3274ed7..ea3e2a6e 100644 --- a/docs/enums/client_api.TransactionType.html +++ b/docs/enums/client_api.TransactionType.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransactionType | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransactionType.html">TransactionType</a></li></ul><h1>Enumeration TransactionType</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1226">src/client/api.ts:1226</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1230">src/client/api.ts:1230</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="client_api.TransactionType.html#Transfer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Transfer</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Transfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Transfer</span><a href="#Transfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Transfer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"transfer"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1227">src/client/api.ts:1227</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#Transfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Transfer</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransactionType | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransactionType.html">TransactionType</a></li></ul><h1>Enumeration TransactionType</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1226">src/client/api.ts:1226</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1230">src/client/api.ts:1230</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="client_api.TransactionType.html#Transfer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Transfer</span></a> +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Transfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Transfer</span><a href="#Transfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Transfer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"transfer"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1227">src/client/api.ts:1227</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#Transfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Transfer</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/enums/coinbase_types.ServerSignerStatus.html b/docs/enums/coinbase_types.ServerSignerStatus.html index 4cdf757e..cc714fdb 100644 --- a/docs/enums/coinbase_types.ServerSignerStatus.html +++ b/docs/enums/coinbase_types.ServerSignerStatus.html @@ -1,4 +1,4 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerSignerStatus | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_types.html">coinbase/types</a></li><li><a href="coinbase_types.ServerSignerStatus.html">ServerSignerStatus</a></li></ul><h1>Enumeration ServerSignerStatus</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ServerSigner status type definition.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L623">src/coinbase/types.ts:623</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="coinbase_types.ServerSignerStatus.html#ACTIVE" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>ACTIVE</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L623">src/coinbase/types.ts:623</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="coinbase_types.ServerSignerStatus.html#ACTIVE" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>ACTIVE</span></a> <a href="coinbase_types.ServerSignerStatus.html#PENDING" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PENDING</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="ACTIVE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ACTIVE</span><a href="#ACTIVE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">ACTIVE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"active_seed"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L625">src/coinbase/types.ts:625</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="PENDING" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>PENDING</span><a href="#PENDING" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">PENDING</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"pending_seed_creation"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L624">src/coinbase/types.ts:624</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#ACTIVE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>ACTIVE</span></a><a href="#PENDING" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PENDING</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="ACTIVE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ACTIVE</span><a href="#ACTIVE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">ACTIVE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"active_seed"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L625">src/coinbase/types.ts:625</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="PENDING" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>PENDING</span><a href="#PENDING" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">PENDING</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"pending_seed_creation"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L624">src/coinbase/types.ts:624</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#ACTIVE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>ACTIVE</span></a><a href="#PENDING" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PENDING</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/enums/coinbase_types.StakeOptionsMode.html b/docs/enums/coinbase_types.StakeOptionsMode.html index e9dd63b1..2cb19ddb 100644 --- a/docs/enums/coinbase_types.StakeOptionsMode.html +++ b/docs/enums/coinbase_types.StakeOptionsMode.html @@ -1,8 +1,8 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakeOptionsMode | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_types.html">coinbase/types</a></li><li><a href="coinbase_types.StakeOptionsMode.html">StakeOptionsMode</a></li></ul><h1>Enumeration StakeOptionsMode</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>StakeOptionsMode type definition.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L695">src/coinbase/types.ts:695</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="coinbase_types.StakeOptionsMode.html#DEFAULT" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DEFAULT</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L695">src/coinbase/types.ts:695</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="coinbase_types.StakeOptionsMode.html#DEFAULT" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DEFAULT</span></a> <a href="coinbase_types.StakeOptionsMode.html#NATIVE" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>NATIVE</span></a> <a href="coinbase_types.StakeOptionsMode.html#PARTIAL" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PARTIAL</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="DEFAULT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DEFAULT</span><a href="#DEFAULT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">DEFAULT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"default"</span></div><div class="tsd-comment tsd-typography"><p>Defaults to the mode specific to the asset.</p> -</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L699">src/coinbase/types.ts:699</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="NATIVE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>NATIVE</span><a href="#NATIVE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">NATIVE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"native"</span></div><div class="tsd-comment tsd-typography"><p>Native represents Native Ethereum Staking mode.</p> -</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L708">src/coinbase/types.ts:708</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="PARTIAL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>PARTIAL</span><a href="#PARTIAL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">PARTIAL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"partial"</span></div><div class="tsd-comment tsd-typography"><p>Partial represents Partial Ethereum Staking mode.</p> -</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L703">src/coinbase/types.ts:703</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#DEFAULT" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DEFAULT</span></a><a href="#NATIVE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>NATIVE</span></a><a href="#PARTIAL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PARTIAL</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L699">src/coinbase/types.ts:699</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="NATIVE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>NATIVE</span><a href="#NATIVE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">NATIVE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"native"</span></div><div class="tsd-comment tsd-typography"><p>Native represents Native Ethereum Staking mode.</p> +</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L708">src/coinbase/types.ts:708</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="PARTIAL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>PARTIAL</span><a href="#PARTIAL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">PARTIAL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"partial"</span></div><div class="tsd-comment tsd-typography"><p>Partial represents Partial Ethereum Staking mode.</p> +</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L703">src/coinbase/types.ts:703</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#DEFAULT" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DEFAULT</span></a><a href="#NATIVE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>NATIVE</span></a><a href="#PARTIAL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PARTIAL</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/enums/coinbase_types.TransactionStatus.html b/docs/enums/coinbase_types.TransactionStatus.html index cd153988..bb45973b 100644 --- a/docs/enums/coinbase_types.TransactionStatus.html +++ b/docs/enums/coinbase_types.TransactionStatus.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransactionStatus | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_types.html">coinbase/types</a></li><li><a href="coinbase_types.TransactionStatus.html">TransactionStatus</a></li></ul><h1>Enumeration TransactionStatus</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Transaction status type definition.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L584">src/coinbase/types.ts:584</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="coinbase_types.TransactionStatus.html#BROADCAST" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>BROADCAST</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L584">src/coinbase/types.ts:584</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="coinbase_types.TransactionStatus.html#BROADCAST" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>BROADCAST</span></a> <a href="coinbase_types.TransactionStatus.html#COMPLETE" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>COMPLETE</span></a> <a href="coinbase_types.TransactionStatus.html#FAILED" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FAILED</span></a> <a href="coinbase_types.TransactionStatus.html#PENDING" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PENDING</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="BROADCAST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>BROADCAST</span><a href="#BROADCAST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">BROADCAST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"broadcast"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L586">src/coinbase/types.ts:586</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="COMPLETE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>COMPLETE</span><a href="#COMPLETE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">COMPLETE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"complete"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L587">src/coinbase/types.ts:587</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="FAILED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>FAILED</span><a href="#FAILED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">FAILED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"failed"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L588">src/coinbase/types.ts:588</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="PENDING" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>PENDING</span><a href="#PENDING" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">PENDING</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"pending"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L585">src/coinbase/types.ts:585</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#BROADCAST" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>BROADCAST</span></a><a href="#COMPLETE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>COMPLETE</span></a><a href="#FAILED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FAILED</span></a><a href="#PENDING" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PENDING</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="BROADCAST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>BROADCAST</span><a href="#BROADCAST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">BROADCAST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"broadcast"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L586">src/coinbase/types.ts:586</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="COMPLETE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>COMPLETE</span><a href="#COMPLETE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">COMPLETE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"complete"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L587">src/coinbase/types.ts:587</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="FAILED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>FAILED</span><a href="#FAILED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">FAILED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"failed"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L588">src/coinbase/types.ts:588</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="PENDING" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>PENDING</span><a href="#PENDING" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">PENDING</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"pending"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L585">src/coinbase/types.ts:585</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#BROADCAST" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>BROADCAST</span></a><a href="#COMPLETE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>COMPLETE</span></a><a href="#FAILED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FAILED</span></a><a href="#PENDING" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PENDING</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/enums/coinbase_types.TransferStatus.html b/docs/enums/coinbase_types.TransferStatus.html index fbdf0aee..fc210b9d 100644 --- a/docs/enums/coinbase_types.TransferStatus.html +++ b/docs/enums/coinbase_types.TransferStatus.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransferStatus | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_types.html">coinbase/types</a></li><li><a href="coinbase_types.TransferStatus.html">TransferStatus</a></li></ul><h1>Enumeration TransferStatus</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Transfer status type definition.</p> -</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L574">src/coinbase/types.ts:574</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="coinbase_types.TransferStatus.html#BROADCAST" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>BROADCAST</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L574">src/coinbase/types.ts:574</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="coinbase_types.TransferStatus.html#BROADCAST" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>BROADCAST</span></a> <a href="coinbase_types.TransferStatus.html#COMPLETE" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>COMPLETE</span></a> <a href="coinbase_types.TransferStatus.html#FAILED" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FAILED</span></a> <a href="coinbase_types.TransferStatus.html#PENDING" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PENDING</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="BROADCAST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>BROADCAST</span><a href="#BROADCAST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">BROADCAST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"broadcast"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L576">src/coinbase/types.ts:576</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="COMPLETE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>COMPLETE</span><a href="#COMPLETE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">COMPLETE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"complete"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L577">src/coinbase/types.ts:577</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="FAILED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>FAILED</span><a href="#FAILED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">FAILED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"failed"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L578">src/coinbase/types.ts:578</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="PENDING" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>PENDING</span><a href="#PENDING" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">PENDING</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"pending"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L575">src/coinbase/types.ts:575</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#BROADCAST" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>BROADCAST</span></a><a href="#COMPLETE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>COMPLETE</span></a><a href="#FAILED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FAILED</span></a><a href="#PENDING" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PENDING</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="BROADCAST" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>BROADCAST</span><a href="#BROADCAST" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">BROADCAST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"broadcast"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L576">src/coinbase/types.ts:576</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="COMPLETE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>COMPLETE</span><a href="#COMPLETE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">COMPLETE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"complete"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L577">src/coinbase/types.ts:577</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="FAILED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>FAILED</span><a href="#FAILED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">FAILED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"failed"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L578">src/coinbase/types.ts:578</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="PENDING" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>PENDING</span><a href="#PENDING" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">PENDING</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"pending"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L575">src/coinbase/types.ts:575</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#BROADCAST" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>BROADCAST</span></a><a href="#COMPLETE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>COMPLETE</span></a><a href="#FAILED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FAILED</span></a><a href="#PENDING" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PENDING</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiAxiosParamCreator.html b/docs/functions/client_api.AddressesApiAxiosParamCreator.html index 09176ac5..c6c1cb43 100644 --- a/docs/functions/client_api.AddressesApiAxiosParamCreator.html +++ b/docs/functions/client_api.AddressesApiAxiosParamCreator.html @@ -31,4 +31,4 @@ <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signatu <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="AddressesApiAxiosParamCreator.__type.requestFaucetFunds.__type-11.__type-12"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1527">src/client/api.ts:1527</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1527">src/client/api.ts:1527</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiFactory.html b/docs/functions/client_api.AddressesApiFactory.html index 84bb3268..e693735b 100644 --- a/docs/functions/client_api.AddressesApiFactory.html +++ b/docs/functions/client_api.AddressesApiFactory.html @@ -3,32 +3,32 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to create the address in.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createAddressRequest</span>: <a href="../interfaces/client_api.CreateAddressRequest.html" class="tsd-signature-type tsd-kind-interface">CreateAddressRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1887">src/client/api.ts:1887</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Address</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFactory.__type.getAddress.getAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><a href="#AddressesApiFactory.__type.getAddress.getAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1887">src/client/api.ts:1887</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Address</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFactory.__type.getAddress.getAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><a href="#AddressesApiFactory.__type.getAddress.getAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get address by onchain address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1898">src/client/api.ts:1898</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFactory.__type.getAddressBalance.getAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><a href="#AddressesApiFactory.__type.getAddressBalance.getAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balance</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1898">src/client/api.ts:1898</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFactory.__type.getAddressBalance.getAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><a href="#AddressesApiFactory.__type.getAddressBalance.getAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balance</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get address balance for asset</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1910">src/client/api.ts:1910</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFactory.__type.listAddressBalances.listAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#AddressesApiFactory.__type.listAddressBalances.listAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balances</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1910">src/client/api.ts:1910</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFactory.__type.listAddressBalances.listAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#AddressesApiFactory.__type.listAddressBalances.listAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balances</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balances for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get all balances for address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1922">src/client/api.ts:1922</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Addresses</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFactory.__type.listAddresses.listAddresses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Addresses</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span><a href="#AddressesApiFactory.__type.listAddresses.listAddresses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List addresses in the wallet.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1922">src/client/api.ts:1922</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Addresses</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFactory.__type.listAddresses.listAddresses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Addresses</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span><a href="#AddressesApiFactory.__type.listAddresses.listAddresses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List addresses in the wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet whose addresses to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List addresses in a wallet.</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1934">src/client/api.ts:1934</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFactory.__type.requestFaucetFunds.requestFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#AddressesApiFactory.__type.requestFaucetFunds.requestFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to onchain address.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1934">src/client/api.ts:1934</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFactory.__type.requestFaucetFunds.requestFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#AddressesApiFactory.__type.requestFaucetFunds.requestFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to onchain address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Request faucet funds for onchain address.</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1945">src/client/api.ts:1945</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1876">src/client/api.ts:1876</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1945">src/client/api.ts:1945</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1876">src/client/api.ts:1876</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiFp.html b/docs/functions/client_api.AddressesApiFp.html index 3e4568f3..21513089 100644 --- a/docs/functions/client_api.AddressesApiFp.html +++ b/docs/functions/client_api.AddressesApiFp.html @@ -3,32 +3,32 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to create the address in.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createAddressRequest</span>: <a href="../interfaces/client_api.CreateAddressRequest.html" class="tsd-signature-type tsd-kind-interface">CreateAddressRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1790">src/client/api.ts:1790</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Address</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFp.__type.getAddress.getAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#AddressesApiFp.__type.getAddress.getAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1790">src/client/api.ts:1790</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Address</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFp.__type.getAddress.getAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#AddressesApiFp.__type.getAddress.getAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get address by onchain address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1804">src/client/api.ts:1804</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFp.__type.getAddressBalance.getAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#AddressesApiFp.__type.getAddressBalance.getAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balance</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1804">src/client/api.ts:1804</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFp.__type.getAddressBalance.getAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#AddressesApiFp.__type.getAddressBalance.getAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balance</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get address balance for asset</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1819">src/client/api.ts:1819</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFp.__type.listAddressBalances.listAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#AddressesApiFp.__type.listAddressBalances.listAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balances</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1819">src/client/api.ts:1819</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFp.__type.listAddressBalances.listAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#AddressesApiFp.__type.listAddressBalances.listAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balances</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balances for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get all balances for address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1834">src/client/api.ts:1834</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Addresses</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFp.__type.listAddresses.listAddresses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Addresses</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#AddressesApiFp.__type.listAddresses.listAddresses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List addresses in the wallet.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1834">src/client/api.ts:1834</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Addresses</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFp.__type.listAddresses.listAddresses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Addresses</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#AddressesApiFp.__type.listAddresses.listAddresses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List addresses in the wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet whose addresses to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List addresses in a wallet.</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1849">src/client/api.ts:1849</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFp.__type.requestFaucetFunds.requestFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#AddressesApiFp.__type.requestFaucetFunds.requestFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to onchain address.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1849">src/client/api.ts:1849</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AddressesApiFp.__type.requestFaucetFunds.requestFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#AddressesApiFp.__type.requestFaucetFunds.requestFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to onchain address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Request faucet funds for onchain address.</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1863">src/client/api.ts:1863</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1779">src/client/api.ts:1779</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1863">src/client/api.ts:1863</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1779">src/client/api.ts:1779</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.AssetsApiAxiosParamCreator.html b/docs/functions/client_api.AssetsApiAxiosParamCreator.html index 6d668a7a..2719bf34 100644 --- a/docs/functions/client_api.AssetsApiAxiosParamCreator.html +++ b/docs/functions/client_api.AssetsApiAxiosParamCreator.html @@ -4,4 +4,4 @@ <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="AssetsApiAxiosParamCreator.__type.getAsset.__type-1.__type-2"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the asset to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2123">src/client/api.ts:2123</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2123">src/client/api.ts:2123</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.AssetsApiFactory.html b/docs/functions/client_api.AssetsApiFactory.html index 356e8726..28c0cb3f 100644 --- a/docs/functions/client_api.AssetsApiFactory.html +++ b/docs/functions/client_api.AssetsApiFactory.html @@ -4,4 +4,4 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the asset to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the asset for the specified asset ID.</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2205">src/client/api.ts:2205</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2194">src/client/api.ts:2194</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2205">src/client/api.ts:2205</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2194">src/client/api.ts:2194</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.AssetsApiFp.html b/docs/functions/client_api.AssetsApiFp.html index 33b52a41..cff93600 100644 --- a/docs/functions/client_api.AssetsApiFp.html +++ b/docs/functions/client_api.AssetsApiFp.html @@ -4,4 +4,4 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the asset to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the asset for the specified asset ID.</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2181">src/client/api.ts:2181</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2170">src/client/api.ts:2170</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2181">src/client/api.ts:2181</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2170">src/client/api.ts:2170</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.ExternalAddressesApiAxiosParamCreator.html b/docs/functions/client_api.ExternalAddressesApiAxiosParamCreator.html index 23c810dc..6edb113e 100644 --- a/docs/functions/client_api.ExternalAddressesApiAxiosParamCreator.html +++ b/docs/functions/client_api.ExternalAddressesApiAxiosParamCreator.html @@ -16,4 +16,4 @@ <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signatu <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="ExternalAddressesApiAxiosParamCreator.__type.requestExternalFaucetFunds.__type-5.__type-6"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2257">src/client/api.ts:2257</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2257">src/client/api.ts:2257</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.ExternalAddressesApiFactory.html b/docs/functions/client_api.ExternalAddressesApiFactory.html index 4f1d7450..b3e40d94 100644 --- a/docs/functions/client_api.ExternalAddressesApiFactory.html +++ b/docs/functions/client_api.ExternalAddressesApiFactory.html @@ -5,15 +5,15 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the asset to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the balance of an asset in an external address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2455">src/client/api.ts:2455</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ExternalAddressesApiFactory.__type.listExternalAddressBalances.listExternalAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#ExternalAddressesApiFactory.__type.listExternalAddressBalances.listExternalAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List all of the balances of an external address</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2455">src/client/api.ts:2455</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ExternalAddressesApiFactory.__type.listExternalAddressBalances.listExternalAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#ExternalAddressesApiFactory.__type.listExternalAddressBalances.listExternalAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List all of the balances of an external address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the balances of an external address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2467">src/client/api.ts:2467</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ExternalAddressesApiFactory.__type.requestExternalFaucetFunds.requestExternalFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#ExternalAddressesApiFactory.__type.requestExternalFaucetFunds.requestExternalFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to external address.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2467">src/client/api.ts:2467</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ExternalAddressesApiFactory.__type.requestExternalFaucetFunds.requestExternalFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#ExternalAddressesApiFactory.__type.requestExternalFaucetFunds.requestExternalFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to external address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Request faucet funds for external address.</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2478">src/client/api.ts:2478</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2443">src/client/api.ts:2443</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2478">src/client/api.ts:2478</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2443">src/client/api.ts:2443</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.ExternalAddressesApiFp.html b/docs/functions/client_api.ExternalAddressesApiFp.html index 4e2965bc..1ca35974 100644 --- a/docs/functions/client_api.ExternalAddressesApiFp.html +++ b/docs/functions/client_api.ExternalAddressesApiFp.html @@ -5,15 +5,15 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the asset to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the balance of an asset in an external address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2401">src/client/api.ts:2401</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ExternalAddressesApiFp.__type.listExternalAddressBalances.listExternalAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ExternalAddressesApiFp.__type.listExternalAddressBalances.listExternalAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List all of the balances of an external address</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2401">src/client/api.ts:2401</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ExternalAddressesApiFp.__type.listExternalAddressBalances.listExternalAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ExternalAddressesApiFp.__type.listExternalAddressBalances.listExternalAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List all of the balances of an external address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the balances of an external address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2416">src/client/api.ts:2416</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ExternalAddressesApiFp.__type.requestExternalFaucetFunds.requestExternalFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ExternalAddressesApiFp.__type.requestExternalFaucetFunds.requestExternalFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to external address.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2416">src/client/api.ts:2416</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ExternalAddressesApiFp.__type.requestExternalFaucetFunds.requestExternalFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ExternalAddressesApiFp.__type.requestExternalFaucetFunds.requestExternalFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to external address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Request faucet funds for external address.</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2430">src/client/api.ts:2430</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2389">src/client/api.ts:2389</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2430">src/client/api.ts:2430</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2389">src/client/api.ts:2389</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html b/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html index 4bfec0e7..a96d4045 100644 --- a/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html +++ b/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html @@ -25,4 +25,4 @@ <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signatu </div><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Submit the result of a server signer event</p> <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="ServerSignersApiAxiosParamCreator.__type.submitServerSignerSignatureEventResult.__type-11.__type-12"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to submit the event result for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">signatureCreationEventResult</span>: <a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2582">src/client/api.ts:2582</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2582">src/client/api.ts:2582</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiFactory.html b/docs/functions/client_api.ServerSignersApiFactory.html index 2e45508e..a6c0802c 100644 --- a/docs/functions/client_api.ServerSignersApiFactory.html +++ b/docs/functions/client_api.ServerSignersApiFactory.html @@ -2,27 +2,27 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-call-signature">createServerSigner</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createServerSignerRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">getServerSigner</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">listServerSignerEvents</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">listServerSigners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">submitServerSignerSeedEventResult</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">seedCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">submitServerSignerSignatureEventResult</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFactory.__type.createServerSigner.createServerSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createServerSignerRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFactory.__type.createServerSigner.createServerSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new Server-Signer</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createServerSignerRequest</span>: <a href="../interfaces/client_api.CreateServerSignerRequest.html" class="tsd-signature-type tsd-kind-interface">CreateServerSignerRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new Server-Signer</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2922">src/client/api.ts:2922</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFactory.__type.getServerSigner.getServerSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFactory.__type.getServerSigner.getServerSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a server signer by ID</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2922">src/client/api.ts:2922</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFactory.__type.getServerSigner.getServerSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFactory.__type.getServerSigner.getServerSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a server signer by ID</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a server signer by ID</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2932">src/client/api.ts:2932</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Server<wbr/>Signer<wbr/>Events</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFactory.__type.listServerSignerEvents.listServerSignerEvents-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signer<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFactory.__type.listServerSignerEvents.listServerSignerEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List events for a server signer</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2932">src/client/api.ts:2932</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Server<wbr/>Signer<wbr/>Events</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFactory.__type.listServerSignerEvents.listServerSignerEvents-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signer<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFactory.__type.listServerSignerEvents.listServerSignerEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List events for a server signer</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to fetch events for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List events for a server signer</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2944">src/client/api.ts:2944</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Server<wbr/>Signers</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFactory.__type.listServerSigners.listServerSigners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFactory.__type.listServerSigners.listServerSigners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List server signers for the current project</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2944">src/client/api.ts:2944</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Server<wbr/>Signers</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFactory.__type.listServerSigners.listServerSigners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFactory.__type.listServerSigners.listServerSigners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List server signers for the current project</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List server signers for the current project</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2955">src/client/api.ts:2955</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFactory.__type.submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">seedCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFactory.__type.submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2955">src/client/api.ts:2955</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFactory.__type.submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">seedCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFactory.__type.submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to submit the event result for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">seedCreationEventResult</span>: <a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Submit the result of a server signer event</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2966">src/client/api.ts:2966</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFactory.__type.submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFactory.__type.submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2966">src/client/api.ts:2966</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFactory.__type.submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFactory.__type.submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to submit the event result for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">signatureCreationEventResult</span>: <a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Submit the result of a server signer event</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2977">src/client/api.ts:2977</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2912">src/client/api.ts:2912</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2977">src/client/api.ts:2977</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2912">src/client/api.ts:2912</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiFp.html b/docs/functions/client_api.ServerSignersApiFp.html index f562d91a..0430b384 100644 --- a/docs/functions/client_api.ServerSignersApiFp.html +++ b/docs/functions/client_api.ServerSignersApiFp.html @@ -2,27 +2,27 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-call-signature">createServerSigner</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createServerSignerRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">getServerSigner</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">listServerSignerEvents</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">listServerSigners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">submitServerSignerSeedEventResult</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">seedCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">submitServerSignerSignatureEventResult</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFp.__type.createServerSigner.createServerSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createServerSignerRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFp.__type.createServerSigner.createServerSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new Server-Signer</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createServerSignerRequest</span>: <a href="../interfaces/client_api.CreateServerSignerRequest.html" class="tsd-signature-type tsd-kind-interface">CreateServerSignerRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new Server-Signer</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2829">src/client/api.ts:2829</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFp.__type.getServerSigner.getServerSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFp.__type.getServerSigner.getServerSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a server signer by ID</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2829">src/client/api.ts:2829</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFp.__type.getServerSigner.getServerSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFp.__type.getServerSigner.getServerSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a server signer by ID</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a server signer by ID</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2842">src/client/api.ts:2842</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Server<wbr/>Signer<wbr/>Events</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFp.__type.listServerSignerEvents.listServerSignerEvents-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signer<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFp.__type.listServerSignerEvents.listServerSignerEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List events for a server signer</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2842">src/client/api.ts:2842</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Server<wbr/>Signer<wbr/>Events</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFp.__type.listServerSignerEvents.listServerSignerEvents-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signer<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFp.__type.listServerSignerEvents.listServerSignerEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List events for a server signer</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to fetch events for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List events for a server signer</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2857">src/client/api.ts:2857</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Server<wbr/>Signers</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFp.__type.listServerSigners.listServerSigners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFp.__type.listServerSigners.listServerSigners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List server signers for the current project</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2857">src/client/api.ts:2857</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Server<wbr/>Signers</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFp.__type.listServerSigners.listServerSigners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFp.__type.listServerSigners.listServerSigners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List server signers for the current project</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List server signers for the current project</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2871">src/client/api.ts:2871</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFp.__type.submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">seedCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFp.__type.submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2871">src/client/api.ts:2871</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFp.__type.submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">seedCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFp.__type.submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to submit the event result for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">seedCreationEventResult</span>: <a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Submit the result of a server signer event</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2885">src/client/api.ts:2885</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFp.__type.submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFp.__type.submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2885">src/client/api.ts:2885</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ServerSignersApiFp.__type.submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ServerSignersApiFp.__type.submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to submit the event result for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">signatureCreationEventResult</span>: <a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Submit the result of a server signer event</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2899">src/client/api.ts:2899</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2819">src/client/api.ts:2819</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2899">src/client/api.ts:2899</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2819">src/client/api.ts:2819</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.StakeApiAxiosParamCreator.html b/docs/functions/client_api.StakeApiAxiosParamCreator.html index 8d3098d4..9853564e 100644 --- a/docs/functions/client_api.StakeApiAxiosParamCreator.html +++ b/docs/functions/client_api.StakeApiAxiosParamCreator.html @@ -16,4 +16,4 @@ <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signatu </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Get staking context for an address</p> </div><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get staking context</p> <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="StakeApiAxiosParamCreator.__type.getStakingContext.__type-7.__type-8"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">getStakingContextRequest</span>: <a href="../interfaces/client_api.GetStakingContextRequest.html" class="tsd-signature-type tsd-kind-interface">GetStakingContextRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3147">src/client/api.ts:3147</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3147">src/client/api.ts:3147</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.StakeApiFactory.html b/docs/functions/client_api.StakeApiFactory.html index 3850c19c..8a0be69f 100644 --- a/docs/functions/client_api.StakeApiFactory.html +++ b/docs/functions/client_api.StakeApiFactory.html @@ -2,18 +2,18 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-call-signature">buildStakingOperation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">fetchStakingRewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">getExternalStakingOperation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">getStakingContext</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">build<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFactory.__type.buildStakingOperation.buildStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#StakeApiFactory.__type.buildStakingOperation.buildStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Build a new staking operation</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>: <a href="../interfaces/client_api.BuildStakingOperationRequest.html" class="tsd-signature-type tsd-kind-interface">BuildStakingOperationRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Build a new staking operation</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3392">src/client/api.ts:3392</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFactory.__type.fetchStakingRewards.fetchStakingRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><a href="#StakeApiFactory.__type.fetchStakingRewards.fetchStakingRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetch staking rewards for a list of addresses</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3392">src/client/api.ts:3392</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFactory.__type.fetchStakingRewards.fetchStakingRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><a href="#StakeApiFactory.__type.fetchStakingRewards.fetchStakingRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetch staking rewards for a list of addresses</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>: <a href="../interfaces/client_api.FetchStakingRewardsRequest.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewardsRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Fetch staking rewards</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3404">src/client/api.ts:3404</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFactory.__type.getExternalStakingOperation.getExternalStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#StakeApiFactory.__type.getExternalStakingOperation.getExternalStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the latest state of a staking operation</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3404">src/client/api.ts:3404</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFactory.__type.getExternalStakingOperation.getExternalStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#StakeApiFactory.__type.getExternalStakingOperation.getExternalStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the latest state of a staking operation</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to fetch the staking operation for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">stakingOperationId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the staking operation</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the latest state of a staking operation</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3416">src/client/api.ts:3416</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFactory.__type.getStakingContext.getStakingContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><a href="#StakeApiFactory.__type.getStakingContext.getStakingContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get staking context for an address</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3416">src/client/api.ts:3416</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFactory.__type.getStakingContext.getStakingContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><a href="#StakeApiFactory.__type.getStakingContext.getStakingContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get staking context for an address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">getStakingContextRequest</span>: <a href="../interfaces/client_api.GetStakingContextRequest.html" class="tsd-signature-type tsd-kind-interface">GetStakingContextRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get staking context</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3426">src/client/api.ts:3426</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3382">src/client/api.ts:3382</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3426">src/client/api.ts:3426</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3382">src/client/api.ts:3382</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.StakeApiFp.html b/docs/functions/client_api.StakeApiFp.html index fd457988..55fd4acb 100644 --- a/docs/functions/client_api.StakeApiFp.html +++ b/docs/functions/client_api.StakeApiFp.html @@ -2,18 +2,18 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-call-signature">buildStakingOperation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">fetchStakingRewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">getExternalStakingOperation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">getStakingContext</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">build<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFp.__type.buildStakingOperation.buildStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#StakeApiFp.__type.buildStakingOperation.buildStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Build a new staking operation</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>: <a href="../interfaces/client_api.BuildStakingOperationRequest.html" class="tsd-signature-type tsd-kind-interface">BuildStakingOperationRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Build a new staking operation</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3326">src/client/api.ts:3326</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFp.__type.fetchStakingRewards.fetchStakingRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#StakeApiFp.__type.fetchStakingRewards.fetchStakingRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetch staking rewards for a list of addresses</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3326">src/client/api.ts:3326</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFp.__type.fetchStakingRewards.fetchStakingRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#StakeApiFp.__type.fetchStakingRewards.fetchStakingRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetch staking rewards for a list of addresses</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>: <a href="../interfaces/client_api.FetchStakingRewardsRequest.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewardsRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Fetch staking rewards</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3341">src/client/api.ts:3341</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFp.__type.getExternalStakingOperation.getExternalStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#StakeApiFp.__type.getExternalStakingOperation.getExternalStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the latest state of a staking operation</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3341">src/client/api.ts:3341</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFp.__type.getExternalStakingOperation.getExternalStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#StakeApiFp.__type.getExternalStakingOperation.getExternalStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the latest state of a staking operation</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to fetch the staking operation for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">stakingOperationId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the staking operation</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the latest state of a staking operation</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3356">src/client/api.ts:3356</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFp.__type.getStakingContext.getStakingContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#StakeApiFp.__type.getStakingContext.getStakingContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get staking context for an address</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3356">src/client/api.ts:3356</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="StakeApiFp.__type.getStakingContext.getStakingContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#StakeApiFp.__type.getStakingContext.getStakingContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get staking context for an address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">getStakingContextRequest</span>: <a href="../interfaces/client_api.GetStakingContextRequest.html" class="tsd-signature-type tsd-kind-interface">GetStakingContextRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get staking context</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3369">src/client/api.ts:3369</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3316">src/client/api.ts:3316</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3369">src/client/api.ts:3369</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3316">src/client/api.ts:3316</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiAxiosParamCreator.html b/docs/functions/client_api.TradesApiAxiosParamCreator.html index 9d25828c..7e73cdeb 100644 --- a/docs/functions/client_api.TradesApiAxiosParamCreator.html +++ b/docs/functions/client_api.TradesApiAxiosParamCreator.html @@ -23,4 +23,4 @@ <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signatu </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3550">src/client/api.ts:3550</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3550">src/client/api.ts:3550</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiFactory.html b/docs/functions/client_api.TradesApiFactory.html index af21696a..63a1c807 100644 --- a/docs/functions/client_api.TradesApiFactory.html +++ b/docs/functions/client_api.TradesApiFactory.html @@ -5,22 +5,22 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">tradeId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the trade to broadcast</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">broadcastTradeRequest</span>: <a href="../interfaces/client_api.BroadcastTradeRequest.html" class="tsd-signature-type tsd-kind-interface">BroadcastTradeRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Broadcast a trade</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3826">src/client/api.ts:3826</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Trade</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TradesApiFactory.__type.createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><a href="#TradesApiFactory.__type.createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new trade</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3826">src/client/api.ts:3826</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Trade</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TradesApiFactory.__type.createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><a href="#TradesApiFactory.__type.createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new trade</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the source address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to conduct the trade from</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">createTradeRequest</span>: <a href="../interfaces/client_api.CreateTradeRequest.html" class="tsd-signature-type tsd-kind-interface">CreateTradeRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new trade for an address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3838">src/client/api.ts:3838</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Trade</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TradesApiFactory.__type.getTrade.getTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><a href="#TradesApiFactory.__type.getTrade.getTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a trade by ID</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3838">src/client/api.ts:3838</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Trade</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TradesApiFactory.__type.getTrade.getTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><a href="#TradesApiFactory.__type.getTrade.getTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a trade by ID</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the trade belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">tradeId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the trade to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a trade by ID</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3850">src/client/api.ts:3850</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Trades</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TradesApiFactory.__type.listTrades.listTrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Trades</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span><a href="#TradesApiFactory.__type.listTrades.listTrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List trades for an address.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3850">src/client/api.ts:3850</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Trades</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TradesApiFactory.__type.listTrades.listTrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Trades</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span><a href="#TradesApiFactory.__type.listTrades.listTrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List trades for an address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to list trades for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List trades for an address.</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3863">src/client/api.ts:3863</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3813">src/client/api.ts:3813</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3863">src/client/api.ts:3863</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3813">src/client/api.ts:3813</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiFp.html b/docs/functions/client_api.TradesApiFp.html index f83f4f52..d614d226 100644 --- a/docs/functions/client_api.TradesApiFp.html +++ b/docs/functions/client_api.TradesApiFp.html @@ -5,22 +5,22 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">tradeId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the trade to broadcast</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">broadcastTradeRequest</span>: <a href="../interfaces/client_api.BroadcastTradeRequest.html" class="tsd-signature-type tsd-kind-interface">BroadcastTradeRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Broadcast a trade</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3754">src/client/api.ts:3754</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Trade</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TradesApiFp.__type.createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#TradesApiFp.__type.createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new trade</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3754">src/client/api.ts:3754</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Trade</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TradesApiFp.__type.createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#TradesApiFp.__type.createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new trade</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the source address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to conduct the trade from</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">createTradeRequest</span>: <a href="../interfaces/client_api.CreateTradeRequest.html" class="tsd-signature-type tsd-kind-interface">CreateTradeRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new trade for an address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3769">src/client/api.ts:3769</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Trade</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TradesApiFp.__type.getTrade.getTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#TradesApiFp.__type.getTrade.getTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a trade by ID</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3769">src/client/api.ts:3769</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Trade</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TradesApiFp.__type.getTrade.getTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#TradesApiFp.__type.getTrade.getTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a trade by ID</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the trade belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">tradeId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the trade to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a trade by ID</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3784">src/client/api.ts:3784</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Trades</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TradesApiFp.__type.listTrades.listTrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Trades</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#TradesApiFp.__type.listTrades.listTrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List trades for an address.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3784">src/client/api.ts:3784</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Trades</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TradesApiFp.__type.listTrades.listTrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Trades</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#TradesApiFp.__type.listTrades.listTrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List trades for an address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to list trades for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List trades for an address.</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3800">src/client/api.ts:3800</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3741">src/client/api.ts:3741</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3800">src/client/api.ts:3800</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3741">src/client/api.ts:3741</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiAxiosParamCreator.html b/docs/functions/client_api.TransfersApiAxiosParamCreator.html index 164b9e96..2a8482a8 100644 --- a/docs/functions/client_api.TransfersApiAxiosParamCreator.html +++ b/docs/functions/client_api.TransfersApiAxiosParamCreator.html @@ -23,4 +23,4 @@ <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signatu </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3999">src/client/api.ts:3999</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3999">src/client/api.ts:3999</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiFactory.html b/docs/functions/client_api.TransfersApiFactory.html index 3a1ef666..222441a8 100644 --- a/docs/functions/client_api.TransfersApiFactory.html +++ b/docs/functions/client_api.TransfersApiFactory.html @@ -5,22 +5,22 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">transferId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the transfer to broadcast</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">broadcastTransferRequest</span>: <a href="../interfaces/client_api.BroadcastTransferRequest.html" class="tsd-signature-type tsd-kind-interface">BroadcastTransferRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Broadcast a transfer</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4275">src/client/api.ts:4275</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Transfer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TransfersApiFactory.__type.createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><a href="#TransfersApiFactory.__type.createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new transfer</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4275">src/client/api.ts:4275</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Transfer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TransfersApiFactory.__type.createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><a href="#TransfersApiFactory.__type.createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new transfer</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the source address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to transfer from</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">createTransferRequest</span>: <a href="../interfaces/client_api.CreateTransferRequest.html" class="tsd-signature-type tsd-kind-interface">CreateTransferRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new transfer for an address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4287">src/client/api.ts:4287</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Transfer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TransfersApiFactory.__type.getTransfer.getTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><a href="#TransfersApiFactory.__type.getTransfer.getTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a transfer by ID</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4287">src/client/api.ts:4287</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Transfer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TransfersApiFactory.__type.getTransfer.getTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><a href="#TransfersApiFactory.__type.getTransfer.getTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a transfer by ID</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the transfer belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">transferId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the transfer to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a transfer by ID</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4299">src/client/api.ts:4299</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Transfers</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TransfersApiFactory.__type.listTransfers.listTransfers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Transfers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span><a href="#TransfersApiFactory.__type.listTransfers.listTransfers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List transfers for an address.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4299">src/client/api.ts:4299</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Transfers</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TransfersApiFactory.__type.listTransfers.listTransfers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Transfers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span><a href="#TransfersApiFactory.__type.listTransfers.listTransfers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List transfers for an address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to list transfers for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List transfers for an address.</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4312">src/client/api.ts:4312</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4262">src/client/api.ts:4262</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4312">src/client/api.ts:4312</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4262">src/client/api.ts:4262</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiFp.html b/docs/functions/client_api.TransfersApiFp.html index 527b05c8..959c9db4 100644 --- a/docs/functions/client_api.TransfersApiFp.html +++ b/docs/functions/client_api.TransfersApiFp.html @@ -5,22 +5,22 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">transferId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the transfer to broadcast</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">broadcastTransferRequest</span>: <a href="../interfaces/client_api.BroadcastTransferRequest.html" class="tsd-signature-type tsd-kind-interface">BroadcastTransferRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Broadcast a transfer</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4203">src/client/api.ts:4203</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Transfer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TransfersApiFp.__type.createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#TransfersApiFp.__type.createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new transfer</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4203">src/client/api.ts:4203</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Transfer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TransfersApiFp.__type.createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#TransfersApiFp.__type.createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new transfer</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the source address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to transfer from</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">createTransferRequest</span>: <a href="../interfaces/client_api.CreateTransferRequest.html" class="tsd-signature-type tsd-kind-interface">CreateTransferRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new transfer for an address</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4218">src/client/api.ts:4218</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Transfer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TransfersApiFp.__type.getTransfer.getTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#TransfersApiFp.__type.getTransfer.getTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a transfer by ID</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4218">src/client/api.ts:4218</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Transfer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TransfersApiFp.__type.getTransfer.getTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#TransfersApiFp.__type.getTransfer.getTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a transfer by ID</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the transfer belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">transferId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the transfer to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a transfer by ID</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4233">src/client/api.ts:4233</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Transfers</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TransfersApiFp.__type.listTransfers.listTransfers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Transfers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#TransfersApiFp.__type.listTransfers.listTransfers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List transfers for an address.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4233">src/client/api.ts:4233</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Transfers</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="TransfersApiFp.__type.listTransfers.listTransfers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Transfers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#TransfersApiFp.__type.listTransfers.listTransfers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List transfers for an address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to list transfers for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List transfers for an address.</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4249">src/client/api.ts:4249</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4190">src/client/api.ts:4190</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4249">src/client/api.ts:4249</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4190">src/client/api.ts:4190</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiAxiosParamCreator.html b/docs/functions/client_api.UsersApiAxiosParamCreator.html index c26838d2..72e227ce 100644 --- a/docs/functions/client_api.UsersApiAxiosParamCreator.html +++ b/docs/functions/client_api.UsersApiAxiosParamCreator.html @@ -2,4 +2,4 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">getCurrentUser</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Current<wbr/>User</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Get current user</p> </div><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get current user</p> <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="UsersApiAxiosParamCreator.__type.getCurrentUser.__type-1.__type-2"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4448">src/client/api.ts:4448</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4448">src/client/api.ts:4448</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiFactory.html b/docs/functions/client_api.UsersApiFactory.html index 8dc11456..ace60fa2 100644 --- a/docs/functions/client_api.UsersApiFactory.html +++ b/docs/functions/client_api.UsersApiFactory.html @@ -2,4 +2,4 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-call-signature">getCurrentUser</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Current<wbr/>User</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="UsersApiFactory.__type.getCurrentUser.getCurrentUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Current<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">></span><a href="#UsersApiFactory.__type.getCurrentUser.getCurrentUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get current user</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get current user</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4518">src/client/api.ts:4518</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4509">src/client/api.ts:4509</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4518">src/client/api.ts:4518</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4509">src/client/api.ts:4509</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiFp.html b/docs/functions/client_api.UsersApiFp.html index ea2e7658..360b5bfb 100644 --- a/docs/functions/client_api.UsersApiFp.html +++ b/docs/functions/client_api.UsersApiFp.html @@ -2,4 +2,4 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-call-signature">getCurrentUser</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Current<wbr/>User</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="UsersApiFp.__type.getCurrentUser.getCurrentUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Current<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#UsersApiFp.__type.getCurrentUser.getCurrentUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get current user</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get current user</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4496">src/client/api.ts:4496</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4487">src/client/api.ts:4487</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4496">src/client/api.ts:4496</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4487">src/client/api.ts:4487</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.ValidatorsApiAxiosParamCreator.html b/docs/functions/client_api.ValidatorsApiAxiosParamCreator.html index da88ceaf..1cd7a3f8 100644 --- a/docs/functions/client_api.ValidatorsApiAxiosParamCreator.html +++ b/docs/functions/client_api.ValidatorsApiAxiosParamCreator.html @@ -13,4 +13,4 @@ <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signatu </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4566">src/client/api.ts:4566</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4566">src/client/api.ts:4566</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.ValidatorsApiFactory.html b/docs/functions/client_api.ValidatorsApiFactory.html index bc288c68..1a535966 100644 --- a/docs/functions/client_api.ValidatorsApiFactory.html +++ b/docs/functions/client_api.ValidatorsApiFactory.html @@ -5,7 +5,7 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">validatorId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique id of the validator to fetch details for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a validator belonging to the CDP project</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4724">src/client/api.ts:4724</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Validators</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ValidatorsApiFactory.__type.listValidators.listValidators-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Validators</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span><a href="#ValidatorsApiFactory.__type.listValidators.listValidators-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List validators belonging to the user for a given network and asset.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4724">src/client/api.ts:4724</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Validators</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ValidatorsApiFactory.__type.listValidators.listValidators-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Validators</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span><a href="#ValidatorsApiFactory.__type.listValidators.listValidators-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List validators belonging to the user for a given network and asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to get the validators for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A filter to list validators based on a status.</p> @@ -13,4 +13,4 @@ <h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="http </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List validators belonging to the CDP project</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4738">src/client/api.ts:4738</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4712">src/client/api.ts:4712</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4738">src/client/api.ts:4738</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4712">src/client/api.ts:4712</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.ValidatorsApiFp.html b/docs/functions/client_api.ValidatorsApiFp.html index f7d0cfd4..a1aca58b 100644 --- a/docs/functions/client_api.ValidatorsApiFp.html +++ b/docs/functions/client_api.ValidatorsApiFp.html @@ -5,7 +5,7 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">validatorId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique id of the validator to fetch details for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a validator belonging to the CDP project</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4682">src/client/api.ts:4682</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Validators</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ValidatorsApiFp.__type.listValidators.listValidators-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Validators</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ValidatorsApiFp.__type.listValidators.listValidators-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List validators belonging to the user for a given network and asset.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4682">src/client/api.ts:4682</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Validators</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ValidatorsApiFp.__type.listValidators.listValidators-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Validators</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#ValidatorsApiFp.__type.listValidators.listValidators-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List validators belonging to the user for a given network and asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to get the validators for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A filter to list validators based on a status.</p> @@ -13,4 +13,4 @@ <h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="http </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List validators belonging to the CDP project</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4699">src/client/api.ts:4699</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4670">src/client/api.ts:4670</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4699">src/client/api.ts:4699</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4670">src/client/api.ts:4670</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiAxiosParamCreator.html b/docs/functions/client_api.WalletsApiAxiosParamCreator.html index 27259441..895fc761 100644 --- a/docs/functions/client_api.WalletsApiAxiosParamCreator.html +++ b/docs/functions/client_api.WalletsApiAxiosParamCreator.html @@ -20,4 +20,4 @@ <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signatu <h4>Throws</h4></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="WalletsApiAxiosParamCreator.__type.listWallets.__type-9.__type-10"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4822">src/client/api.ts:4822</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4822">src/client/api.ts:4822</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiFactory.html b/docs/functions/client_api.WalletsApiFactory.html index 8d956bf7..0b52a0d9 100644 --- a/docs/functions/client_api.WalletsApiFactory.html +++ b/docs/functions/client_api.WalletsApiFactory.html @@ -2,22 +2,22 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-call-signature">createWallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createWalletRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">getWallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">getWalletBalance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">listWalletBalances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">listWallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Wallet</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFactory.__type.createWallet.createWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createWalletRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><a href="#WalletsApiFactory.__type.createWallet.createWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new wallet scoped to the user.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createWalletRequest</span>: <a href="../interfaces/client_api.CreateWalletRequest.html" class="tsd-signature-type tsd-kind-interface">CreateWalletRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new wallet</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5098">src/client/api.ts:5098</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Wallet</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFactory.__type.getWallet.getWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><a href="#WalletsApiFactory.__type.getWallet.getWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get wallet</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5098">src/client/api.ts:5098</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Wallet</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFactory.__type.getWallet.getWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><a href="#WalletsApiFactory.__type.getWallet.getWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get wallet</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get wallet by ID</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5108">src/client/api.ts:5108</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Wallet<wbr/>Balance</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFactory.__type.getWalletBalance.getWalletBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><a href="#WalletsApiFactory.__type.getWalletBalance.getWalletBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the aggregated balance of an asset across all of the addresses in the wallet.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5108">src/client/api.ts:5108</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Wallet<wbr/>Balance</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFactory.__type.getWalletBalance.getWalletBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><a href="#WalletsApiFactory.__type.getWalletBalance.getWalletBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the aggregated balance of an asset across all of the addresses in the wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the balance of an asset in the wallet</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5119">src/client/api.ts:5119</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFactory.__type.listWalletBalances.listWalletBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#WalletsApiFactory.__type.listWalletBalances.listWalletBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the balances of all of the addresses in the wallet aggregated by asset.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5119">src/client/api.ts:5119</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFactory.__type.listWalletBalances.listWalletBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#WalletsApiFactory.__type.listWalletBalances.listWalletBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the balances of all of the addresses in the wallet aggregated by asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balances for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List wallet balances</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5129">src/client/api.ts:5129</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Wallets</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFactory.__type.listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><a href="#WalletsApiFactory.__type.listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List wallets belonging to the user.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5129">src/client/api.ts:5129</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Wallets</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFactory.__type.listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><a href="#WalletsApiFactory.__type.listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List wallets belonging to the user.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List wallets</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5140">src/client/api.ts:5140</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5088">src/client/api.ts:5088</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5140">src/client/api.ts:5140</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5088">src/client/api.ts:5088</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiFp.html b/docs/functions/client_api.WalletsApiFp.html index 914cbe80..9a3c189e 100644 --- a/docs/functions/client_api.WalletsApiFp.html +++ b/docs/functions/client_api.WalletsApiFp.html @@ -2,22 +2,22 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-call-signature">createWallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createWalletRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">getWallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">getWalletBalance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">listWalletBalances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">listWallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Wallet</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFp.__type.createWallet.createWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createWalletRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#WalletsApiFp.__type.createWallet.createWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new wallet scoped to the user.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createWalletRequest</span>: <a href="../interfaces/client_api.CreateWalletRequest.html" class="tsd-signature-type tsd-kind-interface">CreateWalletRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new wallet</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5021">src/client/api.ts:5021</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Wallet</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFp.__type.getWallet.getWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#WalletsApiFp.__type.getWallet.getWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get wallet</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5021">src/client/api.ts:5021</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Wallet</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFp.__type.getWallet.getWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#WalletsApiFp.__type.getWallet.getWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get wallet</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get wallet by ID</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5034">src/client/api.ts:5034</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Wallet<wbr/>Balance</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFp.__type.getWalletBalance.getWalletBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#WalletsApiFp.__type.getWalletBalance.getWalletBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the aggregated balance of an asset across all of the addresses in the wallet.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5034">src/client/api.ts:5034</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Wallet<wbr/>Balance</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFp.__type.getWalletBalance.getWalletBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#WalletsApiFp.__type.getWalletBalance.getWalletBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the aggregated balance of an asset across all of the addresses in the wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the balance of an asset in the wallet</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5048">src/client/api.ts:5048</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFp.__type.listWalletBalances.listWalletBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#WalletsApiFp.__type.listWalletBalances.listWalletBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the balances of all of the addresses in the wallet aggregated by asset.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5048">src/client/api.ts:5048</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFp.__type.listWalletBalances.listWalletBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#WalletsApiFp.__type.listWalletBalances.listWalletBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the balances of all of the addresses in the wallet aggregated by asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balances for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List wallet balances</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5061">src/client/api.ts:5061</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Wallets</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFp.__type.listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#WalletsApiFp.__type.listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List wallets belonging to the user.</p> +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5061">src/client/api.ts:5061</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Wallets</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="WalletsApiFp.__type.listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#WalletsApiFp.__type.listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List wallets belonging to the user.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List wallets</p> -<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5075">src/client/api.ts:5075</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5011">src/client/api.ts:5011</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5075">src/client/api.ts:5075</a></li></ul></aside></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5011">src/client/api.ts:5011</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_common.assertParamExists.html b/docs/functions/client_common.assertParamExists.html index a29da4cd..47dea4cf 100644 --- a/docs/functions/client_common.assertParamExists.html +++ b/docs/functions/client_common.assertParamExists.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>assertParamExists | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.assertParamExists.html">assertParamExists</a></li></ul><h1>Function assertParamExists</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="assertParamExists" class="tsd-anchor"></a><span class="tsd-kind-call-signature">assert<wbr/>Param<wbr/>Exists</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">functionName</span>, <span class="tsd-kind-parameter">paramName</span>, <span class="tsd-kind-parameter">paramValue</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#assertParamExists" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">functionName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">paramName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">paramValue</span>: <span class="tsd-signature-type">unknown</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/common.ts#L32">src/client/common.ts:32</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>assertParamExists | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.assertParamExists.html">assertParamExists</a></li></ul><h1>Function assertParamExists</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="assertParamExists" class="tsd-anchor"></a><span class="tsd-kind-call-signature">assert<wbr/>Param<wbr/>Exists</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">functionName</span>, <span class="tsd-kind-parameter">paramName</span>, <span class="tsd-kind-parameter">paramValue</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#assertParamExists" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">functionName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">paramName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">paramValue</span>: <span class="tsd-signature-type">unknown</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/common.ts#L32">src/client/common.ts:32</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_common.createRequestFunction.html b/docs/functions/client_common.createRequestFunction.html index b9cfddb4..64610fca 100644 --- a/docs/functions/client_common.createRequestFunction.html +++ b/docs/functions/client_common.createRequestFunction.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createRequestFunction | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.createRequestFunction.html">createRequestFunction</a></li></ul><h1>Function createRequestFunction</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createRequestFunction" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Request<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axiosArgs</span>, <span class="tsd-kind-parameter">globalAxios</span>, <span class="tsd-kind-parameter">BASE_PATH</span>, <span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><a href="#createRequestFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">axiosArgs</span>: <a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a></span></li><li><span><span class="tsd-kind-parameter">globalAxios</span>: <span class="tsd-signature-type">AxiosInstance</span></span></li><li><span><span class="tsd-kind-parameter">BASE_PATH</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createRequestFunction.__type.__type-1"><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="createRequestFunction.__type.__type-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="createRequestFunction.__type.__type-1.R" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">R</span> = <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.T">T</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/common.ts#L185">src/client/common.ts:185</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createRequestFunction | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.createRequestFunction.html">createRequestFunction</a></li></ul><h1>Function createRequestFunction</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createRequestFunction" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Request<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axiosArgs</span>, <span class="tsd-kind-parameter">globalAxios</span>, <span class="tsd-kind-parameter">BASE_PATH</span>, <span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><a href="#createRequestFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">axiosArgs</span>: <a href="../interfaces/client_base.RequestArgs.html" class="tsd-signature-type tsd-kind-interface">RequestArgs</a></span></li><li><span><span class="tsd-kind-parameter">globalAxios</span>: <span class="tsd-signature-type">AxiosInstance</span></span></li><li><span><span class="tsd-kind-parameter">BASE_PATH</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createRequestFunction.__type.__type-1"><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="createRequestFunction.__type.__type-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li><li><span><a id="createRequestFunction.__type.__type-1.R" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">R</span> = <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.T">T</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></span></li><li><span><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="client_common.createRequestFunction.html#createRequestFunction.__type.__type-1.R">R</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/common.ts#L185">src/client/common.ts:185</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_common.serializeDataIfNeeded.html b/docs/functions/client_common.serializeDataIfNeeded.html index 5c158c47..1e9554de 100644 --- a/docs/functions/client_common.serializeDataIfNeeded.html +++ b/docs/functions/client_common.serializeDataIfNeeded.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>serializeDataIfNeeded | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.serializeDataIfNeeded.html">serializeDataIfNeeded</a></li></ul><h1>Function serializeDataIfNeeded</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="serializeDataIfNeeded" class="tsd-anchor"></a><span class="tsd-kind-call-signature">serialize<wbr/>Data<wbr/>If<wbr/>Needed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">requestOptions</span>, <span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#serializeDataIfNeeded" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">requestOptions</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/common.ts#L123">src/client/common.ts:123</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>serializeDataIfNeeded | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.serializeDataIfNeeded.html">serializeDataIfNeeded</a></li></ul><h1>Function serializeDataIfNeeded</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="serializeDataIfNeeded" class="tsd-anchor"></a><span class="tsd-kind-call-signature">serialize<wbr/>Data<wbr/>If<wbr/>Needed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">requestOptions</span>, <span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#serializeDataIfNeeded" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">requestOptions</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/common.ts#L123">src/client/common.ts:123</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_common.setApiKeyToObject.html b/docs/functions/client_common.setApiKeyToObject.html index fce42502..ebf77e08 100644 --- a/docs/functions/client_common.setApiKeyToObject.html +++ b/docs/functions/client_common.setApiKeyToObject.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setApiKeyToObject | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.setApiKeyToObject.html">setApiKeyToObject</a></li></ul><h1>Function setApiKeyToObject</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setApiKeyToObject" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Api<wbr/>Key<wbr/>To<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">object</span>, <span class="tsd-kind-parameter">keyParamName</span>, <span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setApiKeyToObject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">object</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">keyParamName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/common.ts#L42">src/client/common.ts:42</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setApiKeyToObject | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.setApiKeyToObject.html">setApiKeyToObject</a></li></ul><h1>Function setApiKeyToObject</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setApiKeyToObject" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Api<wbr/>Key<wbr/>To<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">object</span>, <span class="tsd-kind-parameter">keyParamName</span>, <span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setApiKeyToObject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">object</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">keyParamName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/common.ts#L42">src/client/common.ts:42</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_common.setBasicAuthToObject.html b/docs/functions/client_common.setBasicAuthToObject.html index fc2fe784..5e28fb02 100644 --- a/docs/functions/client_common.setBasicAuthToObject.html +++ b/docs/functions/client_common.setBasicAuthToObject.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setBasicAuthToObject | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.setBasicAuthToObject.html">setBasicAuthToObject</a></li></ul><h1>Function setBasicAuthToObject</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setBasicAuthToObject" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Basic<wbr/>Auth<wbr/>To<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">object</span>, <span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setBasicAuthToObject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">object</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/common.ts#L55">src/client/common.ts:55</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setBasicAuthToObject | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.setBasicAuthToObject.html">setBasicAuthToObject</a></li></ul><h1>Function setBasicAuthToObject</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setBasicAuthToObject" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Basic<wbr/>Auth<wbr/>To<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">object</span>, <span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setBasicAuthToObject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">object</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/common.ts#L55">src/client/common.ts:55</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_common.setBearerAuthToObject.html b/docs/functions/client_common.setBearerAuthToObject.html index 2768f2c3..ec120bac 100644 --- a/docs/functions/client_common.setBearerAuthToObject.html +++ b/docs/functions/client_common.setBearerAuthToObject.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setBearerAuthToObject | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.setBearerAuthToObject.html">setBearerAuthToObject</a></li></ul><h1>Function setBearerAuthToObject</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setBearerAuthToObject" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Bearer<wbr/>Auth<wbr/>To<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">object</span>, <span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setBearerAuthToObject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">object</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/common.ts#L65">src/client/common.ts:65</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setBearerAuthToObject | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.setBearerAuthToObject.html">setBearerAuthToObject</a></li></ul><h1>Function setBearerAuthToObject</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setBearerAuthToObject" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Bearer<wbr/>Auth<wbr/>To<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">object</span>, <span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setBearerAuthToObject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">object</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/common.ts#L65">src/client/common.ts:65</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_common.setOAuthToObject.html b/docs/functions/client_common.setOAuthToObject.html index 0940c126..8262da63 100644 --- a/docs/functions/client_common.setOAuthToObject.html +++ b/docs/functions/client_common.setOAuthToObject.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setOAuthToObject | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.setOAuthToObject.html">setOAuthToObject</a></li></ul><h1>Function setOAuthToObject</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setOAuthToObject" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setOAuth<wbr/>To<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">object</span>, <span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">scopes</span>, <span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setOAuthToObject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">object</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">scopes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/common.ts#L78">src/client/common.ts:78</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setOAuthToObject | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.setOAuthToObject.html">setOAuthToObject</a></li></ul><h1>Function setOAuthToObject</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setOAuthToObject" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setOAuth<wbr/>To<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">object</span>, <span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">scopes</span>, <span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setOAuthToObject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">object</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">scopes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/client_configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/common.ts#L78">src/client/common.ts:78</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_common.setSearchParams.html b/docs/functions/client_common.setSearchParams.html index 0cc79866..48cd93ad 100644 --- a/docs/functions/client_common.setSearchParams.html +++ b/docs/functions/client_common.setSearchParams.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setSearchParams | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.setSearchParams.html">setSearchParams</a></li></ul><h1>Function setSearchParams</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setSearchParams" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Search<wbr/>Params</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">objects</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setSearchParams" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">URL</span></span></li><li><span><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">objects</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/common.ts#L113">src/client/common.ts:113</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setSearchParams | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.setSearchParams.html">setSearchParams</a></li></ul><h1>Function setSearchParams</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setSearchParams" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Search<wbr/>Params</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">objects</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setSearchParams" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">URL</span></span></li><li><span><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">objects</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/common.ts#L113">src/client/common.ts:113</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/client_common.toPathString.html b/docs/functions/client_common.toPathString.html index 95ce61ae..4ced9630 100644 --- a/docs/functions/client_common.toPathString.html +++ b/docs/functions/client_common.toPathString.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>toPathString | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.toPathString.html">toPathString</a></li></ul><h1>Function toPathString</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toPathString" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Path<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toPathString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">URL</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/common.ts#L177">src/client/common.ts:177</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>toPathString | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.toPathString.html">toPathString</a></li></ul><h1>Function toPathString</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toPathString" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Path<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toPathString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">URL</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/common.ts#L177">src/client/common.ts:177</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/coinbase_utils.convertStringToHex.html b/docs/functions/coinbase_utils.convertStringToHex.html index 2f115067..e179b72c 100644 --- a/docs/functions/coinbase_utils.convertStringToHex.html +++ b/docs/functions/coinbase_utils.convertStringToHex.html @@ -1,4 +1,4 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>convertStringToHex | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_utils.html">coinbase/utils</a></li><li><a href="coinbase_utils.convertStringToHex.html">convertStringToHex</a></li></ul><h1>Function convertStringToHex</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="convertStringToHex" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>String<wbr/>To<wbr/>Hex</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#convertStringToHex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts a Uint8Array to a hex string.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">Uint8Array</span></span><div class="tsd-comment tsd-typography"><p>The key to convert.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The converted hex string.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/utils.ts#L71">src/coinbase/utils.ts:71</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/utils.ts#L71">src/coinbase/utils.ts:71</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/coinbase_utils.delay.html b/docs/functions/coinbase_utils.delay.html index 8d5c19a9..814da1f8 100644 --- a/docs/functions/coinbase_utils.delay.html +++ b/docs/functions/coinbase_utils.delay.html @@ -1,4 +1,4 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>delay | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_utils.html">coinbase/utils</a></li><li><a href="coinbase_utils.delay.html">delay</a></li></ul><h1>Function delay</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="delay" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delay</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seconds</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#delay" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delays the execution of the function by the specified number of seconds.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">seconds</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The number of seconds to delay the execution.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves after the specified number of seconds.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/utils.ts#L81">src/coinbase/utils.ts:81</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/utils.ts#L81">src/coinbase/utils.ts:81</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/coinbase_utils.logApiResponse.html b/docs/functions/coinbase_utils.logApiResponse.html index 66912cf3..67b2bd91 100644 --- a/docs/functions/coinbase_utils.logApiResponse.html +++ b/docs/functions/coinbase_utils.logApiResponse.html @@ -2,4 +2,4 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The Axios response object.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">debugging</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Flag to enable or disable logging.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>The Axios response object.</p> -<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/utils.ts#L13">src/coinbase/utils.ts:13</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/utils.ts#L13">src/coinbase/utils.ts:13</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/coinbase_utils.parseUnsignedPayload.html b/docs/functions/coinbase_utils.parseUnsignedPayload.html index 31e19202..26d049e1 100644 --- a/docs/functions/coinbase_utils.parseUnsignedPayload.html +++ b/docs/functions/coinbase_utils.parseUnsignedPayload.html @@ -2,4 +2,4 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">payload</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The Unsigned Payload.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>The parsed JSON object.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the Unsigned Payload is invalid.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/utils.ts#L92">src/coinbase/utils.ts:92</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/utils.ts#L92">src/coinbase/utils.ts:92</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/functions/coinbase_utils.registerAxiosInterceptors.html b/docs/functions/coinbase_utils.registerAxiosInterceptors.html index a00f1c9d..8555c599 100644 --- a/docs/functions/coinbase_utils.registerAxiosInterceptors.html +++ b/docs/functions/coinbase_utils.registerAxiosInterceptors.html @@ -2,4 +2,4 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">axiosInstance</span>: <span class="tsd-signature-type">Axios</span></span><div class="tsd-comment tsd-typography"><p>The Axios instance to register the interceptors.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">requestFn</span>: <span class="tsd-signature-type">RequestFunctionType</span></span><div class="tsd-comment tsd-typography"><p>The request interceptor function.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">responseFn</span>: <span class="tsd-signature-type">ResponseFunctionType</span></span><div class="tsd-comment tsd-typography"><p>The response interceptor function.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/utils.ts#L54">src/coinbase/utils.ts:54</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/utils.ts#L54">src/coinbase/utils.ts:54</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 45a5eee5..32b048ad 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,7 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@coinbase/coinbase-sdk</h2></div><div class="tsd-panel tsd-typography"><a id="md:coinbase-nodejs-sdk" class="tsd-anchor"></a><h1><a href="#md:coinbase-nodejs-sdk">Coinbase Node.js SDK</a></h1><p>The Coinbase Node.js SDK enables the simple integration of crypto into your app. By calling Coinbase's Platform APIs, the SDK allows you to provision crypto wallets, send crypto into/out of those wallets, track wallet balances, and trade crypto from one asset into another.</p> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@coinbase/coinbase-sdk</h2></div><div class="tsd-panel tsd-typography"><a id="md:coinbase-nodejs-sdk" class="tsd-anchor"></a><h1><a href="#md:coinbase-nodejs-sdk">Coinbase Node.js SDK</a></h1><p><a href="https://www.npmjs.com/package/@coinbase/coinbase-sdk"><img src="https://img.shields.io/npm/v/@coinbase/coinbase-sdk" alt="NPM Package"></a> +<a href="https://bundlephobia.com/result?p=@coinbase/coinbase-sdk"><img src="https://badgen.net/bundlephobia/minzip/@coinbase/coinbase-sdk" alt="Build Size"></a> +<a href="https://www.npmtrends.com/@coinbase/coinbase-sdk"><img src="https://img.shields.io/npm/dw/@coinbase/coinbase-sdk" alt="NPM Downloads"></a></p> +<p>The Coinbase Node.js SDK enables the simple integration of crypto into your app. By calling Coinbase's Platform APIs, the SDK allows you to provision crypto wallets, send crypto into/out of those wallets, track wallet balances, and trade crypto from one asset into another.</p> <p>The SDK currently supports Customer-custodied Wallets on the Base Sepolia test network.</p> <p><strong>NOTE: The Coinbase SDK is currently in Alpha. The SDK:</strong></p> <ul> @@ -51,7 +54,7 @@ <pre><code class="language-typescript"><span class="hl-4">// Create a Wallet with one Address by default.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-5">wallet</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">user</span><span class="hl-1">.</span><span class="hl-0">createWallet</span><span class="hl-1">();</span> </code><button>Copy</button></pre> <p>Next, view the default Address of your Wallet. You will need this default Address in order to fund the Wallet for your first Transfer.</p> -<pre><code class="language-typescript"><span class="hl-4">// A Wallet has a default Address.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-5">address</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">wallet</span><span class="hl-1">.</span><span class="hl-0">getDefaultAddress</span><span class="hl-1">();</span><br/><span class="hl-7">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-3">`Address: </span><span class="hl-2">${</span><span class="hl-7">address</span><span class="hl-2">}</span><span class="hl-3">`</span><span class="hl-1">);</span> +<pre><code class="language-typescript"><span class="hl-4">// A Wallet has a default Address.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-5">address</span><span class="hl-1"> = </span><span class="hl-7">wallet</span><span class="hl-1">.</span><span class="hl-0">getDefaultAddress</span><span class="hl-1">();</span><br/><span class="hl-7">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-3">`Address: </span><span class="hl-2">${</span><span class="hl-7">address</span><span class="hl-2">}</span><span class="hl-3">`</span><span class="hl-1">);</span> </code><button>Copy</button></pre> <p>Wallets do not have funds on them to start. In order to fund the Address, you will need to send funds to the Wallet you generated above. If you don't have testnet funds, get funds from a <a href="https://docs.base.org/docs/tools/network-faucets/">faucet</a>.</p> <p>For development purposes, we provide a <code>faucet</code> method to fund your address with ETH on Base Sepolia testnet. We allow one faucet claim per address in a 24 hour window.</p> @@ -59,7 +62,7 @@ </code><button>Copy</button></pre> <pre><code class="language-typescript"><span class="hl-4">// Create a new Wallet to transfer funds to.</span><br/><span class="hl-4">// Then, we can transfer 0.00001 ETH out of the Wallet to another Wallet.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-5">anotherWallet</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">user</span><span class="hl-1">.</span><span class="hl-0">createWallet</span><span class="hl-1">();</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-5">transfer</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">wallet</span><span class="hl-1">.</span><span class="hl-0">createTransfer</span><span class="hl-1">({ </span><span class="hl-7">amount:</span><span class="hl-1"> </span><span class="hl-8">0.00001</span><span class="hl-1">, </span><span class="hl-7">assetId:</span><span class="hl-1"> </span><span class="hl-7">Coinbase</span><span class="hl-1">.</span><span class="hl-7">assets</span><span class="hl-1">.</span><span class="hl-7">Eth</span><span class="hl-1">, </span><span class="hl-7">destination:</span><span class="hl-1"> </span><span class="hl-7">anotherWallet</span><span class="hl-1"> });</span> </code><button>Copy</button></pre> -<a id="md:trading-funds" class="tsd-anchor"></a><h3><a href="#md:trading-funds">Trading Funds</a></h3><pre><code class="language-typescript"><span class="hl-4">// Create a Wallet on `base-mainnet` to trade assets with.</span><br/><span class="hl-2">let</span><span class="hl-1"> </span><span class="hl-7">mainnetWallet</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">user</span><span class="hl-1">.</span><span class="hl-0">createWallet</span><span class="hl-1">({ </span><span class="hl-7">networkId:</span><span class="hl-1"> </span><span class="hl-7">Coinbase</span><span class="hl-1">.</span><span class="hl-7">networks</span><span class="hl-1">.</span><span class="hl-7">BaseMainnet</span><span class="hl-1"> });</span><br/><br/><span class="hl-7">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-3">`Wallet successfully created: </span><span class="hl-2">${</span><span class="hl-7">mainnetWallet</span><span class="hl-2">}</span><span class="hl-3">`</span><span class="hl-1">);</span><br/><br/><span class="hl-4">// Fund your Wallet's default Address with ETH from an external source.</span><br/><br/><span class="hl-4">// Trade 0.00001 ETH to USDC</span><br/><span class="hl-2">let</span><span class="hl-1"> </span><span class="hl-7">trade</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">wallet</span><span class="hl-1">.</span><span class="hl-0">createTrade</span><span class="hl-1">(</span><span class="hl-8">0.00001</span><span class="hl-1">, </span><span class="hl-7">Coinbase</span><span class="hl-1">.</span><span class="hl-7">assets</span><span class="hl-1">.</span><span class="hl-7">Eth</span><span class="hl-1">, </span><span class="hl-7">Coinbase</span><span class="hl-1">.</span><span class="hl-7">assets</span><span class="hl-1">.</span><span class="hl-7">Usdc</span><span class="hl-1">);</span><br/><br/><span class="hl-7">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-3">`Second trade successfully completed: </span><span class="hl-2">${</span><span class="hl-7">trade</span><span class="hl-2">}</span><span class="hl-3">`</span><span class="hl-1">);</span> +<a id="md:trading-funds" class="tsd-anchor"></a><h3><a href="#md:trading-funds">Trading Funds</a></h3><pre><code class="language-typescript"><span class="hl-4">// Create a Wallet on `base-mainnet` to trade assets with.</span><br/><span class="hl-2">let</span><span class="hl-1"> </span><span class="hl-7">mainnetWallet</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">user</span><span class="hl-1">.</span><span class="hl-0">createWallet</span><span class="hl-1">({ </span><span class="hl-7">networkId:</span><span class="hl-1"> </span><span class="hl-7">Coinbase</span><span class="hl-1">.</span><span class="hl-7">networks</span><span class="hl-1">.</span><span class="hl-7">BaseMainnet</span><span class="hl-1"> });</span><br/><br/><span class="hl-7">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-3">`Wallet successfully created: </span><span class="hl-2">${</span><span class="hl-7">mainnetWallet</span><span class="hl-2">}</span><span class="hl-3">`</span><span class="hl-1">);</span><br/><br/><span class="hl-4">// Fund your Wallet's default Address with ETH from an external source.</span><br/><br/><span class="hl-4">// Trade 0.00001 ETH to USDC</span><br/><span class="hl-2">let</span><span class="hl-1"> </span><span class="hl-7">trade</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">wallet</span><span class="hl-1">.</span><span class="hl-0">createTrade</span><span class="hl-1">({ </span><span class="hl-7">amount:</span><span class="hl-1"> </span><span class="hl-8">0.00001</span><span class="hl-1">, </span><span class="hl-7">fromAssetId:</span><span class="hl-1"> </span><span class="hl-7">Coinbase</span><span class="hl-1">.</span><span class="hl-7">assets</span><span class="hl-1">.</span><span class="hl-7">Eth</span><span class="hl-1">, </span><span class="hl-7">toAssetId:</span><span class="hl-1"> </span><span class="hl-7">Coinbase</span><span class="hl-1">.</span><span class="hl-7">assets</span><span class="hl-1">.</span><span class="hl-7">Usdc</span><span class="hl-1"> });</span><br/><br/><span class="hl-7">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-3">`Second trade successfully completed: </span><span class="hl-2">${</span><span class="hl-7">trade</span><span class="hl-2">}</span><span class="hl-3">`</span><span class="hl-1">);</span> </code><button>Copy</button></pre> <a id="md:re-instantiating-wallets" class="tsd-anchor"></a><h3><a href="#md:re-instantiating-wallets">Re-Instantiating Wallets</a></h3><p>The SDK creates Wallets with developer managed keys, which means you are responsible for securely storing the keys required to re-instantiate Wallets. The below code walks you through how to export a Wallet and store it in a secure location.</p> <pre><code class="language-typescript"><span class="hl-4">// Export the data required to re-instantiate the Wallet.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1"> = </span><span class="hl-7">wallet</span><span class="hl-1">.</span><span class="hl-0">export</span><span class="hl-1">();</span> @@ -77,31 +80,6 @@ <pre><code class="language-typescript"><span class="hl-4">// The Wallet can be re-instantiated using the exported data.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-5">importedWallet</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">user</span><span class="hl-1">.</span><span class="hl-0">importWallet</span><span class="hl-1">(</span><span class="hl-7">data</span><span class="hl-1">);</span> </code><button>Copy</button></pre> <p>To import Wallets that were persisted to your local file system using <code>saveSeed</code>, use the below code.</p> -<pre><code class="language-typescript"><span class="hl-4">// The Wallet can be re-instantiated using the exported data.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-5">w</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">user</span><span class="hl-1">.</span><span class="hl-0">getWallet</span><span class="hl-1">(</span><span class="hl-7">w</span><span class="hl-1">.</span><span class="hl-0">getId</span><span class="hl-1">());</span><br/><span class="hl-7">w</span><span class="hl-1">.</span><span class="hl-0">loadSeed</span><span class="hl-1">(</span><span class="hl-7">filePath</span><span class="hl-1">);</span> +<pre><code class="language-typescript"><span class="hl-4">// Ensure your seed file path is updated</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-5">seedFilePath</span><span class="hl-1"> = </span><span class="hl-3">""</span><span class="hl-1">;</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-5">userWallet</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">user</span><span class="hl-1">.</span><span class="hl-0">getWallet</span><span class="hl-1">(</span><span class="hl-7">wallet</span><span class="hl-1">.</span><span class="hl-0">getId</span><span class="hl-1">());</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">userWallet</span><span class="hl-1">.</span><span class="hl-0">loadSeed</span><span class="hl-1">(</span><span class="hl-7">seedFilePath</span><span class="hl-1">);</span> </code><button>Copy</button></pre> -<a id="md:development" class="tsd-anchor"></a><h2><a href="#md:development">Development</a></h2><a id="md:nodejs-version" class="tsd-anchor"></a><h3><a href="#md:nodejs-version">Node.js Version</a></h3><p>Developing in this repository requires Node.js 18 or higher.</p> -<a id="md:set-up" class="tsd-anchor"></a><h3><a href="#md:set-up">Set-up</a></h3><p>Clone the repo by running:</p> -<pre><code class="language-bash"><span class="hl-0">git</span><span class="hl-1"> </span><span class="hl-3">clone</span><span class="hl-1"> </span><span class="hl-3">git@github.com:coinbase/coinbase-sdk-nodejs.git</span> -</code><button>Copy</button></pre> -<p>To install all dependencies, run:</p> -<pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-3">install</span> -</code><button>Copy</button></pre> -<a id="md:linting" class="tsd-anchor"></a><h3><a href="#md:linting">Linting</a></h3><p>To autocorrect all lint errors, run:</p> -<pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">lint-fix</span> -</code><button>Copy</button></pre> -<p>To detect all lint errors, run:</p> -<pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">lint</span> -</code><button>Copy</button></pre> -<a id="md:testing" class="tsd-anchor"></a><h3><a href="#md:testing">Testing</a></h3><p>To run all tests, run:</p> -<pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-3">test</span> -</code><button>Copy</button></pre> -<p>To run a specific test, run (for example):</p> -<pre><code class="language-bash"><span class="hl-0">npx</span><span class="hl-1"> </span><span class="hl-3">jest</span><span class="hl-1"> </span><span class="hl-3">./src/coinbase/tests/wallet_test.ts</span> -</code><button>Copy</button></pre> -<p>To run e2e tests, run:</p> -<pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">test:dry-run</span><span class="hl-1"> && </span><span class="hl-7">NAME</span><span class="hl-1">=</span><span class="hl-3">"placeholder"</span><span class="hl-1"> </span><span class="hl-7">PRIVATE_KEY</span><span class="hl-1">=</span><span class="hl-3">"placeholder"</span><span class="hl-1"> </span><span class="hl-7">WALLET_DATA</span><span class="hl-1">=</span><span class="hl-3">"placeholder"</span><span class="hl-1"> && </span><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">test:e2e</span> -</code><button>Copy</button></pre> -<a id="md:generating-documentation" class="tsd-anchor"></a><h3><a href="#md:generating-documentation">Generating Documentation</a></h3><p>To generate documentation from the TypeDoc comments, run:</p> -<pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">docs</span> -</code><button>Copy</button></pre> -</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:coinbase-nodejs-sdk"><span>Coinbase <wbr/>Node.js SDK</span></a><ul><li><a href="#md:documentation"><span>Documentation</span></a></li><li><a href="#md:requirements"><span>Requirements</span></a></li><li><a href="#md:installation"><span>Installation</span></a></li><li><ul><li><ul><li><a href="#md:you-can-import-the-sdk-as-follows"><span>You can import the SDK as follows</span></a></li></ul></li></ul></li><li><a href="#md:usage"><span>Usage</span></a></li><li><ul><li><a href="#md:initialization"><span>Initialization</span></a></li><li><ul><li><a href="#md:you-can-import-the-sdk-as-follows-1"><span>You can import the SDK as follows:</span></a></li></ul></li><li><a href="#md:wallets-addresses-and-transfers"><span>Wallets, <wbr/>Addresses, and <wbr/>Transfers</span></a></li><li><a href="#md:trading-funds"><span>Trading <wbr/>Funds</span></a></li><li><a href="#md:re-instantiating-wallets"><span>Re-<wbr/>Instantiating <wbr/>Wallets</span></a></li></ul></li><li><a href="#md:development"><span>Development</span></a></li><li><ul><li><a href="#md:nodejs-version"><span>Node.js <wbr/>Version</span></a></li><li><a href="#md:set-up"><span>Set-<wbr/>up</span></a></li><li><a href="#md:linting"><span>Linting</span></a></li><li><a href="#md:testing"><span>Testing</span></a></li><li><a href="#md:generating-documentation"><span>Generating <wbr/>Documentation</span></a></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:coinbase-nodejs-sdk"><span>Coinbase <wbr/>Node.js SDK</span></a><ul><li><a href="#md:documentation"><span>Documentation</span></a></li><li><a href="#md:requirements"><span>Requirements</span></a></li><li><a href="#md:installation"><span>Installation</span></a></li><li><ul><li><ul><li><a href="#md:you-can-import-the-sdk-as-follows"><span>You can import the SDK as follows</span></a></li></ul></li></ul></li><li><a href="#md:usage"><span>Usage</span></a></li><li><ul><li><a href="#md:initialization"><span>Initialization</span></a></li><li><ul><li><a href="#md:you-can-import-the-sdk-as-follows-1"><span>You can import the SDK as follows:</span></a></li></ul></li><li><a href="#md:wallets-addresses-and-transfers"><span>Wallets, <wbr/>Addresses, and <wbr/>Transfers</span></a></li><li><a href="#md:trading-funds"><span>Trading <wbr/>Funds</span></a></li><li><a href="#md:re-instantiating-wallets"><span>Re-<wbr/>Instantiating <wbr/>Wallets</span></a></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.Address.html b/docs/interfaces/client_api.Address.html index c13f18ec..35eb890d 100644 --- a/docs/interfaces/client_api.Address.html +++ b/docs/interfaces/client_api.Address.html @@ -1,14 +1,14 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Address | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.Address.html">Address</a></li></ul><h1>Interface Address</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>Address</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Address</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Address.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Address.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Address.html#public_key">public_key</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Address.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L31">src/client/api.ts:31</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Address.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Address</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Address.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Address.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Address.html#public_key">public_key</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Address.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L31">src/client/api.ts:31</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Address.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> <a href="client_api.Address.html#network_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a> <a href="client_api.Address.html#public_key" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>public_<wbr/>key</span></a> <a href="client_api.Address.html#wallet_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="address_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>id</span><a href="#address_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The onchain address derived on the server-side.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Address</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L55">src/client/api.ts:55</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L55">src/client/api.ts:55</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Address</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L43">src/client/api.ts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="public_key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>public_<wbr/>key</span><a href="#public_key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">public_<wbr/>key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The public key from which the address is derived.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L43">src/client/api.ts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="public_key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>public_<wbr/>key</span><a href="#public_key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">public_<wbr/>key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The public key from which the address is derived.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Address</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L49">src/client/api.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet that owns the address</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L49">src/client/api.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet that owns the address</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Address</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L37">src/client/api.ts:37</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#public_key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>public_<wbr/>key</span></a><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L37">src/client/api.ts:37</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#public_key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>public_<wbr/>key</span></a><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressBalanceList.html b/docs/interfaces/client_api.AddressBalanceList.html index d31f69c0..85dec56c 100644 --- a/docs/interfaces/client_api.AddressBalanceList.html +++ b/docs/interfaces/client_api.AddressBalanceList.html @@ -1,13 +1,13 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AddressBalanceList | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.AddressBalanceList.html">AddressBalanceList</a></li></ul><h1>Interface AddressBalanceList</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>AddressBalanceList</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AddressBalanceList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressBalanceList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressBalanceList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressBalanceList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressBalanceList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L62">src/client/api.ts:62</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.AddressBalanceList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AddressBalanceList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressBalanceList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressBalanceList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressBalanceList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressBalanceList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L62">src/client/api.ts:62</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.AddressBalanceList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> <a href="client_api.AddressBalanceList.html#has_more" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a> <a href="client_api.AddressBalanceList.html#next_page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a> <a href="client_api.AddressBalanceList.html#total_count" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>AddressBalanceList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L68">src/client/api.ts:68</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L68">src/client/api.ts:68</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>AddressBalanceList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L74">src/client/api.ts:74</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L74">src/client/api.ts:74</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>AddressBalanceList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L80">src/client/api.ts:80</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of balances for the wallet.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L80">src/client/api.ts:80</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of balances for the wallet.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>AddressBalanceList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L86">src/client/api.ts:86</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L86">src/client/api.ts:86</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressList.html b/docs/interfaces/client_api.AddressList.html index 2419d1e7..dcb18892 100644 --- a/docs/interfaces/client_api.AddressList.html +++ b/docs/interfaces/client_api.AddressList.html @@ -1,13 +1,13 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AddressList | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.AddressList.html">AddressList</a></li></ul><h1>Interface AddressList</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>AddressList</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AddressList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L93">src/client/api.ts:93</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.AddressList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AddressList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.AddressList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L93">src/client/api.ts:93</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.AddressList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> <a href="client_api.AddressList.html#has_more" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a> <a href="client_api.AddressList.html#next_page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a> <a href="client_api.AddressList.html#total_count" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>AddressList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L99">src/client/api.ts:99</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L99">src/client/api.ts:99</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>AddressList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L105">src/client/api.ts:105</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L105">src/client/api.ts:105</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>AddressList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L111">src/client/api.ts:111</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of addresses for the wallet.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L111">src/client/api.ts:111</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of addresses for the wallet.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>AddressList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L117">src/client/api.ts:117</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L117">src/client/api.ts:117</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressesApiInterface.html b/docs/interfaces/client_api.AddressesApiInterface.html index ede5b94b..62baa7fa 100644 --- a/docs/interfaces/client_api.AddressesApiInterface.html +++ b/docs/interfaces/client_api.AddressesApiInterface.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AddressesApiInterface | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.AddressesApiInterface.html">AddressesApiInterface</a></li></ul><h1>Interface AddressesApiInterface</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>AddressesApi - interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>AddressesApi</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AddressesApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AddressesApiInterface.html#createAddress.createAddress-1">createAddress</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">createAddressRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AddressesApiInterface.html#getAddress.getAddress-1">getAddress</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AddressesApiInterface.html#getAddressBalance.getAddressBalance-1">getAddressBalance</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AddressesApiInterface.html#listAddressBalances.listAddressBalances-1">listAddressBalances</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AddressesApiInterface.html#listAddresses.listAddresses-1">listAddresses</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AddressesApiInterface.html#requestFaucetFunds.requestFaucetFunds-1">requestFaucetFunds</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.AddressesApi.html" class="tsd-signature-type tsd-kind-class">AddressesApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1956">src/client/api.ts:1956</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.AddressesApiInterface.html#createAddress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Address</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AddressesApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AddressesApiInterface.html#createAddress.createAddress-1">createAddress</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">createAddressRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AddressesApiInterface.html#getAddress.getAddress-1">getAddress</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AddressesApiInterface.html#getAddressBalance.getAddressBalance-1">getAddressBalance</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AddressesApiInterface.html#listAddressBalances.listAddressBalances-1">listAddressBalances</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AddressesApiInterface.html#listAddresses.listAddresses-1">listAddresses</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AddressesApiInterface.html#requestFaucetFunds.requestFaucetFunds-1">requestFaucetFunds</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.AddressesApi.html" class="tsd-signature-type tsd-kind-class">AddressesApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1956">src/client/api.ts:1956</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.AddressesApiInterface.html#createAddress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Address</span></a> <a href="client_api.AddressesApiInterface.html#getAddress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address</span></a> <a href="client_api.AddressesApiInterface.html#getAddressBalance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address<wbr/>Balance</span></a> <a href="client_api.AddressesApiInterface.html#listAddressBalances" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Address<wbr/>Balances</span></a> @@ -11,37 +11,37 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createAddressRequest</span>: <a href="client_api.CreateAddressRequest.html" class="tsd-signature-type tsd-kind-interface">CreateAddressRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new address</p> <h4>Throws</h4><h4>Memberof</h4><p>AddressesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1966">src/client/api.ts:1966</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Address</span><a href="#getAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAddress.getAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><a href="#getAddress.getAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1966">src/client/api.ts:1966</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Address</span><a href="#getAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAddress.getAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><a href="#getAddress.getAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get address by onchain address</p> <h4>Throws</h4><h4>Memberof</h4><p>AddressesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1977">src/client/api.ts:1977</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAddressBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Address<wbr/>Balance</span><a href="#getAddressBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAddressBalance.getAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><a href="#getAddressBalance.getAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balance</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1977">src/client/api.ts:1977</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAddressBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Address<wbr/>Balance</span><a href="#getAddressBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAddressBalance.getAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><a href="#getAddressBalance.getAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balance</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get address balance for asset</p> <h4>Throws</h4><h4>Memberof</h4><p>AddressesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1989">src/client/api.ts:1989</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listAddressBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Address<wbr/>Balances</span><a href="#listAddressBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listAddressBalances.listAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#listAddressBalances.listAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balances</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1989">src/client/api.ts:1989</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listAddressBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Address<wbr/>Balances</span><a href="#listAddressBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listAddressBalances.listAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#listAddressBalances.listAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balances</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balances for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get all balances for address</p> <h4>Throws</h4><h4>Memberof</h4><p>AddressesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2001">src/client/api.ts:2001</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listAddresses" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Addresses</span><a href="#listAddresses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listAddresses.listAddresses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Addresses</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span><a href="#listAddresses.listAddresses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List addresses in the wallet.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2001">src/client/api.ts:2001</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listAddresses" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Addresses</span><a href="#listAddresses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listAddresses.listAddresses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Addresses</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span><a href="#listAddresses.listAddresses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List addresses in the wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet whose addresses to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List addresses in a wallet.</p> <h4>Throws</h4><h4>Memberof</h4><p>AddressesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2013">src/client/api.ts:2013</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="requestFaucetFunds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>Faucet<wbr/>Funds</span><a href="#requestFaucetFunds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="requestFaucetFunds.requestFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#requestFaucetFunds.requestFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to onchain address.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2013">src/client/api.ts:2013</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="requestFaucetFunds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>Faucet<wbr/>Funds</span><a href="#requestFaucetFunds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="requestFaucetFunds.requestFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#requestFaucetFunds.requestFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to onchain address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Request faucet funds for onchain address.</p> <h4>Throws</h4><h4>Memberof</h4><p>AddressesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2024">src/client/api.ts:2024</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#createAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Address</span></a><a href="#getAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address</span></a><a href="#getAddressBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address<wbr/>Balance</span></a><a href="#listAddressBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Address<wbr/>Balances</span></a><a href="#listAddresses" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Addresses</span></a><a href="#requestFaucetFunds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Faucet<wbr/>Funds</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2024">src/client/api.ts:2024</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#createAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Address</span></a><a href="#getAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address</span></a><a href="#getAddressBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address<wbr/>Balance</span></a><a href="#listAddressBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Address<wbr/>Balances</span></a><a href="#listAddresses" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Addresses</span></a><a href="#requestFaucetFunds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Faucet<wbr/>Funds</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.Asset.html b/docs/interfaces/client_api.Asset.html index 121da7e7..2f8cd89c 100644 --- a/docs/interfaces/client_api.Asset.html +++ b/docs/interfaces/client_api.Asset.html @@ -1,15 +1,15 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Asset | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.Asset.html">Asset</a></li></ul><h1>Interface Asset</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An asset onchain scoped to a particular network, e.g. ETH on base-sepolia, or the USDC ERC20 Token on ethereum-mainnet.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>Asset</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Asset</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Asset.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Asset.html#contract_address">contract_address</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Asset.html#decimals">decimals</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Asset.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L124">src/client/api.ts:124</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Asset.html#asset_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Asset</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Asset.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Asset.html#contract_address">contract_address</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Asset.html#decimals">decimals</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Asset.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L124">src/client/api.ts:124</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Asset.html#asset_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a> <a href="client_api.Asset.html#contract_address" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>contract_<wbr/>address?</span></a> <a href="client_api.Asset.html#decimals" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>decimals?</span></a> <a href="client_api.Asset.html#network_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset_<wbr/>id</span><a href="#asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID for the asset on the network</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Asset</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L136">src/client/api.ts:136</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="contract_address" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>contract_<wbr/>address</span><a href="#contract_address" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">contract_<wbr/>address</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The optional contract address for the asset. This will be specified for smart contract-based assets, for example ERC20s.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L136">src/client/api.ts:136</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="contract_address" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>contract_<wbr/>address</span><a href="#contract_address" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">contract_<wbr/>address</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The optional contract address for the asset. This will be specified for smart contract-based assets, for example ERC20s.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Asset</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L148">src/client/api.ts:148</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="decimals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>decimals</span><a href="#decimals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">decimals</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The number of decimals the asset supports. This is used to convert from atomic units to base units.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L148">src/client/api.ts:148</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="decimals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>decimals</span><a href="#decimals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">decimals</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The number of decimals the asset supports. This is used to convert from atomic units to base units.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Asset</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L142">src/client/api.ts:142</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L142">src/client/api.ts:142</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Asset</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L130">src/client/api.ts:130</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#contract_address" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>contract_<wbr/>address</span></a><a href="#decimals" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>decimals</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L130">src/client/api.ts:130</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#contract_address" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>contract_<wbr/>address</span></a><a href="#decimals" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>decimals</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.AssetsApiInterface.html b/docs/interfaces/client_api.AssetsApiInterface.html index 9e42ded0..bf2b5fc3 100644 --- a/docs/interfaces/client_api.AssetsApiInterface.html +++ b/docs/interfaces/client_api.AssetsApiInterface.html @@ -1,10 +1,10 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AssetsApiInterface | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.AssetsApiInterface.html">AssetsApiInterface</a></li></ul><h1>Interface AssetsApiInterface</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>AssetsApi - interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>AssetsApi</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AssetsApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AssetsApiInterface.html#getAsset.getAsset-1">getAsset</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.AssetsApi.html" class="tsd-signature-type tsd-kind-class">AssetsApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2216">src/client/api.ts:2216</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.AssetsApiInterface.html#getAsset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AssetsApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.AssetsApiInterface.html#getAsset.getAsset-1">getAsset</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.AssetsApi.html" class="tsd-signature-type tsd-kind-class">AssetsApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2216">src/client/api.ts:2216</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.AssetsApiInterface.html#getAsset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getAsset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Asset</span><a href="#getAsset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAsset.getAsset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Asset</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">></span><a href="#getAsset.getAsset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the asset for the specified asset ID.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the asset to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the asset for the specified asset ID.</p> <h4>Throws</h4><h4>Memberof</h4><p>AssetsApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2226">src/client/api.ts:2226</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#getAsset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2226">src/client/api.ts:2226</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#getAsset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.Balance.html b/docs/interfaces/client_api.Balance.html index 3e12aa72..b7a6309a 100644 --- a/docs/interfaces/client_api.Balance.html +++ b/docs/interfaces/client_api.Balance.html @@ -1,8 +1,8 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Balance | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.Balance.html">Balance</a></li></ul><h1>Interface Balance</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The balance of an asset onchain</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>Balance</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Balance</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Balance.html#amount">amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Balance.html#asset">asset</a><span class="tsd-signature-symbol">: </span><a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L155">src/client/api.ts:155</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Balance.html#amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Balance</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Balance.html#amount">amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Balance.html#asset">asset</a><span class="tsd-signature-symbol">: </span><a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L155">src/client/api.ts:155</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Balance.html#amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a> <a href="client_api.Balance.html#asset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>amount</span><a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The amount in the atomic units of the asset</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Balance</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L161">src/client/api.ts:161</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset</span><a href="#asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Balance</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L167">src/client/api.ts:167</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#asset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L161">src/client/api.ts:161</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset</span><a href="#asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Balance</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L167">src/client/api.ts:167</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#asset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.BroadcastTradeRequest.html b/docs/interfaces/client_api.BroadcastTradeRequest.html index 1f52b57a..cba06e36 100644 --- a/docs/interfaces/client_api.BroadcastTradeRequest.html +++ b/docs/interfaces/client_api.BroadcastTradeRequest.html @@ -1,8 +1,8 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BroadcastTradeRequest | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.BroadcastTradeRequest.html">BroadcastTradeRequest</a></li></ul><h1>Interface BroadcastTradeRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>BroadcastTradeRequest</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">BroadcastTradeRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BroadcastTradeRequest.html#approve_transaction_signed_payload">approve_transaction_signed_payload</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BroadcastTradeRequest.html#signed_payload">signed_payload</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L174">src/client/api.ts:174</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.BroadcastTradeRequest.html#approve_transaction_signed_payload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>approve_<wbr/>transaction_<wbr/>signed_<wbr/>payload?</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">BroadcastTradeRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BroadcastTradeRequest.html#approve_transaction_signed_payload">approve_transaction_signed_payload</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BroadcastTradeRequest.html#signed_payload">signed_payload</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L174">src/client/api.ts:174</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.BroadcastTradeRequest.html#approve_transaction_signed_payload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>approve_<wbr/>transaction_<wbr/>signed_<wbr/>payload?</span></a> <a href="client_api.BroadcastTradeRequest.html#signed_payload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>payload</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="approve_transaction_signed_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>approve_<wbr/>transaction_<wbr/>signed_<wbr/>payload</span><a href="#approve_transaction_signed_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">approve_<wbr/>transaction_<wbr/>signed_<wbr/>payload</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The hex-encoded signed payload of the approval transaction</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BroadcastTradeRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L186">src/client/api.ts:186</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="signed_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>signed_<wbr/>payload</span><a href="#signed_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signed_<wbr/>payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The hex-encoded signed payload of the trade</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L186">src/client/api.ts:186</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="signed_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>signed_<wbr/>payload</span><a href="#signed_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signed_<wbr/>payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The hex-encoded signed payload of the trade</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BroadcastTradeRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L180">src/client/api.ts:180</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#approve_transaction_signed_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>approve_<wbr/>transaction_<wbr/>signed_<wbr/>payload</span></a><a href="#signed_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>payload</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L180">src/client/api.ts:180</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#approve_transaction_signed_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>approve_<wbr/>transaction_<wbr/>signed_<wbr/>payload</span></a><a href="#signed_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>payload</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.BroadcastTransferRequest.html b/docs/interfaces/client_api.BroadcastTransferRequest.html index d4aa0cb8..9713d311 100644 --- a/docs/interfaces/client_api.BroadcastTransferRequest.html +++ b/docs/interfaces/client_api.BroadcastTransferRequest.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BroadcastTransferRequest | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.BroadcastTransferRequest.html">BroadcastTransferRequest</a></li></ul><h1>Interface BroadcastTransferRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>BroadcastTransferRequest</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">BroadcastTransferRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BroadcastTransferRequest.html#signed_payload">signed_payload</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L193">src/client/api.ts:193</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.BroadcastTransferRequest.html#signed_payload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>payload</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">BroadcastTransferRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BroadcastTransferRequest.html#signed_payload">signed_payload</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L193">src/client/api.ts:193</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.BroadcastTransferRequest.html#signed_payload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>payload</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="signed_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>signed_<wbr/>payload</span><a href="#signed_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signed_<wbr/>payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The hex-encoded signed payload of the transfer</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BroadcastTransferRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L199">src/client/api.ts:199</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#signed_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>payload</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L199">src/client/api.ts:199</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#signed_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>payload</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.BuildStakingOperationRequest.html b/docs/interfaces/client_api.BuildStakingOperationRequest.html index fd5f82df..53813e19 100644 --- a/docs/interfaces/client_api.BuildStakingOperationRequest.html +++ b/docs/interfaces/client_api.BuildStakingOperationRequest.html @@ -1,16 +1,16 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BuildStakingOperationRequest | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.BuildStakingOperationRequest.html">BuildStakingOperationRequest</a></li></ul><h1>Interface BuildStakingOperationRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>BuildStakingOperationRequest</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">BuildStakingOperationRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BuildStakingOperationRequest.html#action">action</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BuildStakingOperationRequest.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BuildStakingOperationRequest.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BuildStakingOperationRequest.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BuildStakingOperationRequest.html#options">options</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L206">src/client/api.ts:206</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.BuildStakingOperationRequest.html#action" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>action</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">BuildStakingOperationRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BuildStakingOperationRequest.html#action">action</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BuildStakingOperationRequest.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BuildStakingOperationRequest.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BuildStakingOperationRequest.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.BuildStakingOperationRequest.html#options">options</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L206">src/client/api.ts:206</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.BuildStakingOperationRequest.html#action" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>action</span></a> <a href="client_api.BuildStakingOperationRequest.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> <a href="client_api.BuildStakingOperationRequest.html#asset_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a> <a href="client_api.BuildStakingOperationRequest.html#network_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a> <a href="client_api.BuildStakingOperationRequest.html#options" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="action" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>action</span><a href="#action" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">action</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The type of staking operation</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BuildStakingOperationRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L230">src/client/api.ts:230</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="address_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>id</span><a href="#address_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The onchain address from which the staking transaction originates and is responsible for signing the transaction.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L230">src/client/api.ts:230</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="address_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>id</span><a href="#address_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The onchain address from which the staking transaction originates and is responsible for signing the transaction.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BuildStakingOperationRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L224">src/client/api.ts:224</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset_<wbr/>id</span><a href="#asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset being staked</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L224">src/client/api.ts:224</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset_<wbr/>id</span><a href="#asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset being staked</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BuildStakingOperationRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L218">src/client/api.ts:218</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L218">src/client/api.ts:218</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BuildStakingOperationRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L212">src/client/api.ts:212</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BuildStakingOperationRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L236">src/client/api.ts:236</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#action" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>action</span></a><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#options" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L212">src/client/api.ts:212</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BuildStakingOperationRequest</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L236">src/client/api.ts:236</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#action" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>action</span></a><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#options" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateAddressRequest.html b/docs/interfaces/client_api.CreateAddressRequest.html index 09568dc8..5f57e587 100644 --- a/docs/interfaces/client_api.CreateAddressRequest.html +++ b/docs/interfaces/client_api.CreateAddressRequest.html @@ -1,8 +1,8 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateAddressRequest | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.CreateAddressRequest.html">CreateAddressRequest</a></li></ul><h1>Interface CreateAddressRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>CreateAddressRequest</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateAddressRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateAddressRequest.html#attestation">attestation</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateAddressRequest.html#public_key">public_key</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L243">src/client/api.ts:243</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.CreateAddressRequest.html#attestation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attestation?</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateAddressRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateAddressRequest.html#attestation">attestation</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateAddressRequest.html#public_key">public_key</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L243">src/client/api.ts:243</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.CreateAddressRequest.html#attestation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attestation?</span></a> <a href="client_api.CreateAddressRequest.html#public_key" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>public_<wbr/>key?</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="attestation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>attestation</span><a href="#attestation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">attestation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>An attestation signed by the private key that is associated with the wallet. The attestation will be a hex-encoded signature of a json payload with fields <code>wallet_id</code> and <code>public_key</code>, signed by the private key associated with the public_key set in the request.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateAddressRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L255">src/client/api.ts:255</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="public_key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>public_<wbr/>key</span><a href="#public_key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">public_<wbr/>key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The public key from which the address will be derived.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L255">src/client/api.ts:255</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="public_key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>public_<wbr/>key</span><a href="#public_key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">public_<wbr/>key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The public key from which the address will be derived.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateAddressRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L249">src/client/api.ts:249</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#attestation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attestation</span></a><a href="#public_key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>public_<wbr/>key</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L249">src/client/api.ts:249</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#attestation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attestation</span></a><a href="#public_key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>public_<wbr/>key</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateServerSignerRequest.html b/docs/interfaces/client_api.CreateServerSignerRequest.html index d27f2331..7357d3d1 100644 --- a/docs/interfaces/client_api.CreateServerSignerRequest.html +++ b/docs/interfaces/client_api.CreateServerSignerRequest.html @@ -1,11 +1,11 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateServerSignerRequest | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.CreateServerSignerRequest.html">CreateServerSignerRequest</a></li></ul><h1>Interface CreateServerSignerRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>CreateServerSignerRequest</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateServerSignerRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateServerSignerRequest.html#enrollment_data">enrollment_data</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateServerSignerRequest.html#is_mpc">is_mpc</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateServerSignerRequest.html#server_signer_id">server_signer_id</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L262">src/client/api.ts:262</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.CreateServerSignerRequest.html#enrollment_data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enrollment_<wbr/>data</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateServerSignerRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateServerSignerRequest.html#enrollment_data">enrollment_data</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateServerSignerRequest.html#is_mpc">is_mpc</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateServerSignerRequest.html#server_signer_id">server_signer_id</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L262">src/client/api.ts:262</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.CreateServerSignerRequest.html#enrollment_data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enrollment_<wbr/>data</span></a> <a href="client_api.CreateServerSignerRequest.html#is_mpc" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>mpc</span></a> <a href="client_api.CreateServerSignerRequest.html#server_signer_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server_<wbr/>signer_<wbr/>id?</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="enrollment_data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enrollment_<wbr/>data</span><a href="#enrollment_data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enrollment_<wbr/>data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The enrollment data of the server signer. This will be the base64 encoded server-signer-id for the 1 of 1 server signer.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateServerSignerRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L274">src/client/api.ts:274</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="is_mpc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is_<wbr/>mpc</span><a href="#is_mpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is_<wbr/>mpc</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the Server-Signer uses MPC.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L274">src/client/api.ts:274</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="is_mpc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is_<wbr/>mpc</span><a href="#is_mpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is_<wbr/>mpc</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the Server-Signer uses MPC.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateServerSignerRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L280">src/client/api.ts:280</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="server_signer_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>server_<wbr/>signer_<wbr/>id</span><a href="#server_signer_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">server_<wbr/>signer_<wbr/>id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the server signer for the 1 of 1 server signer.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L280">src/client/api.ts:280</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="server_signer_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>server_<wbr/>signer_<wbr/>id</span><a href="#server_signer_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">server_<wbr/>signer_<wbr/>id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the server signer for the 1 of 1 server signer.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateServerSignerRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L268">src/client/api.ts:268</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#enrollment_data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enrollment_<wbr/>data</span></a><a href="#is_mpc" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>mpc</span></a><a href="#server_signer_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server_<wbr/>signer_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L268">src/client/api.ts:268</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#enrollment_data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enrollment_<wbr/>data</span></a><a href="#is_mpc" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>mpc</span></a><a href="#server_signer_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server_<wbr/>signer_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateTradeRequest.html b/docs/interfaces/client_api.CreateTradeRequest.html index 7589dedd..44304784 100644 --- a/docs/interfaces/client_api.CreateTradeRequest.html +++ b/docs/interfaces/client_api.CreateTradeRequest.html @@ -1,11 +1,11 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateTradeRequest | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.CreateTradeRequest.html">CreateTradeRequest</a></li></ul><h1>Interface CreateTradeRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>CreateTradeRequest</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateTradeRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTradeRequest.html#amount">amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTradeRequest.html#from_asset_id">from_asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTradeRequest.html#to_asset_id">to_asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L287">src/client/api.ts:287</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.CreateTradeRequest.html#amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateTradeRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTradeRequest.html#amount">amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTradeRequest.html#from_asset_id">from_asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTradeRequest.html#to_asset_id">to_asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L287">src/client/api.ts:287</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.CreateTradeRequest.html#amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a> <a href="client_api.CreateTradeRequest.html#from_asset_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>asset_<wbr/>id</span></a> <a href="client_api.CreateTradeRequest.html#to_asset_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to_<wbr/>asset_<wbr/>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>amount</span><a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The amount to trade</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateTradeRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L293">src/client/api.ts:293</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="from_asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from_<wbr/>asset_<wbr/>id</span><a href="#from_asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">from_<wbr/>asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset to trade</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L293">src/client/api.ts:293</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="from_asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from_<wbr/>asset_<wbr/>id</span><a href="#from_asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">from_<wbr/>asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset to trade</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateTradeRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L299">src/client/api.ts:299</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="to_asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to_<wbr/>asset_<wbr/>id</span><a href="#to_asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">to_<wbr/>asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset to receive from the trade</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L299">src/client/api.ts:299</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="to_asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to_<wbr/>asset_<wbr/>id</span><a href="#to_asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">to_<wbr/>asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset to receive from the trade</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateTradeRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L305">src/client/api.ts:305</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#from_asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>asset_<wbr/>id</span></a><a href="#to_asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to_<wbr/>asset_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L305">src/client/api.ts:305</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#from_asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>asset_<wbr/>id</span></a><a href="#to_asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to_<wbr/>asset_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateTransferRequest.html b/docs/interfaces/client_api.CreateTransferRequest.html index 77481de0..420dc506 100644 --- a/docs/interfaces/client_api.CreateTransferRequest.html +++ b/docs/interfaces/client_api.CreateTransferRequest.html @@ -1,14 +1,14 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateTransferRequest | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.CreateTransferRequest.html">CreateTransferRequest</a></li></ul><h1>Interface CreateTransferRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>CreateTransferRequest</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateTransferRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTransferRequest.html#amount">amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTransferRequest.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTransferRequest.html#destination">destination</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTransferRequest.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L312">src/client/api.ts:312</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.CreateTransferRequest.html#amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateTransferRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTransferRequest.html#amount">amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTransferRequest.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTransferRequest.html#destination">destination</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateTransferRequest.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L312">src/client/api.ts:312</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.CreateTransferRequest.html#amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a> <a href="client_api.CreateTransferRequest.html#asset_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a> <a href="client_api.CreateTransferRequest.html#destination" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>destination</span></a> <a href="client_api.CreateTransferRequest.html#network_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>amount</span><a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The amount to transfer</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateTransferRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L318">src/client/api.ts:318</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset_<wbr/>id</span><a href="#asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset to transfer</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L318">src/client/api.ts:318</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset_<wbr/>id</span><a href="#asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset to transfer</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateTransferRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L330">src/client/api.ts:330</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="destination" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destination</span><a href="#destination" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">destination</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The destination address</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L330">src/client/api.ts:330</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="destination" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destination</span><a href="#destination" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">destination</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The destination address</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateTransferRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L336">src/client/api.ts:336</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L336">src/client/api.ts:336</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateTransferRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L324">src/client/api.ts:324</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#destination" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>destination</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L324">src/client/api.ts:324</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#destination" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>destination</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateWalletRequest.html b/docs/interfaces/client_api.CreateWalletRequest.html index f44d3204..17ab5302 100644 --- a/docs/interfaces/client_api.CreateWalletRequest.html +++ b/docs/interfaces/client_api.CreateWalletRequest.html @@ -1,4 +1,4 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateWalletRequest | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.CreateWalletRequest.html">CreateWalletRequest</a></li></ul><h1>Interface CreateWalletRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>CreateWalletRequest</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateWalletRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateWalletRequest.html#wallet">wallet</a><span class="tsd-signature-symbol">: </span><a href="client_api.CreateWalletRequestWallet.html" class="tsd-signature-type tsd-kind-interface">CreateWalletRequestWallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L343">src/client/api.ts:343</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.CreateWalletRequest.html#wallet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateWalletRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateWalletRequest.html#wallet">wallet</a><span class="tsd-signature-symbol">: </span><a href="client_api.CreateWalletRequestWallet.html" class="tsd-signature-type tsd-kind-interface">CreateWalletRequestWallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L343">src/client/api.ts:343</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.CreateWalletRequest.html#wallet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="wallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet</span><a href="#wallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet</span><span class="tsd-signature-symbol">:</span> <a href="client_api.CreateWalletRequestWallet.html" class="tsd-signature-type tsd-kind-interface">CreateWalletRequestWallet</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateWalletRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L349">src/client/api.ts:349</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#wallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L349">src/client/api.ts:349</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#wallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateWalletRequestWallet.html b/docs/interfaces/client_api.CreateWalletRequestWallet.html index 7b9e5777..7096487e 100644 --- a/docs/interfaces/client_api.CreateWalletRequestWallet.html +++ b/docs/interfaces/client_api.CreateWalletRequestWallet.html @@ -1,9 +1,9 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateWalletRequestWallet | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.CreateWalletRequestWallet.html">CreateWalletRequestWallet</a></li></ul><h1>Interface CreateWalletRequestWallet</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Parameters for configuring a wallet</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>CreateWalletRequestWallet</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateWalletRequestWallet</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateWalletRequestWallet.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateWalletRequestWallet.html#use_server_signer">use_server_signer</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L356">src/client/api.ts:356</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.CreateWalletRequestWallet.html#network_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateWalletRequestWallet</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateWalletRequestWallet.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.CreateWalletRequestWallet.html#use_server_signer">use_server_signer</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L356">src/client/api.ts:356</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.CreateWalletRequestWallet.html#network_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a> <a href="client_api.CreateWalletRequestWallet.html#use_server_signer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use_<wbr/>server_<wbr/>signer?</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateWalletRequestWallet</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L362">src/client/api.ts:362</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="use_server_signer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>use_<wbr/>server_<wbr/>signer</span><a href="#use_server_signer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">use_<wbr/>server_<wbr/>signer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the wallet should use the project's server signer or if the addresses in the wallets will belong to a private key the developer manages. Defaults to false.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L362">src/client/api.ts:362</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="use_server_signer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>use_<wbr/>server_<wbr/>signer</span><a href="#use_server_signer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">use_<wbr/>server_<wbr/>signer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the wallet should use the project's server signer or if the addresses in the wallets will belong to a private key the developer manages. Defaults to false.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>CreateWalletRequestWallet</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L368">src/client/api.ts:368</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#use_server_signer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use_<wbr/>server_<wbr/>signer</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L368">src/client/api.ts:368</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#use_server_signer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use_<wbr/>server_<wbr/>signer</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.EthereumValidatorMetadata.html b/docs/interfaces/client_api.EthereumValidatorMetadata.html index 208ee2aa..47c6e390 100644 --- a/docs/interfaces/client_api.EthereumValidatorMetadata.html +++ b/docs/interfaces/client_api.EthereumValidatorMetadata.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EthereumValidatorMetadata | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.EthereumValidatorMetadata.html">EthereumValidatorMetadata</a></li></ul><h1>Interface EthereumValidatorMetadata</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An Ethereum validator.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>EthereumValidatorMetadata</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">EthereumValidatorMetadata</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#activationEpoch">activationEpoch</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#balance">balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#effective_balance">effective_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#exitEpoch">exitEpoch</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#index">index</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#public_key">public_key</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#slashed">slashed</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#withdrawableEpoch">withdrawableEpoch</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#withdrawl_address">withdrawl_address</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L375">src/client/api.ts:375</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.EthereumValidatorMetadata.html#activationEpoch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>activation<wbr/>Epoch</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">EthereumValidatorMetadata</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#activationEpoch">activationEpoch</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#balance">balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#effective_balance">effective_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#exitEpoch">exitEpoch</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#index">index</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#public_key">public_key</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#slashed">slashed</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#withdrawableEpoch">withdrawableEpoch</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.EthereumValidatorMetadata.html#withdrawl_address">withdrawl_address</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L375">src/client/api.ts:375</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.EthereumValidatorMetadata.html#activationEpoch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>activation<wbr/>Epoch</span></a> <a href="client_api.EthereumValidatorMetadata.html#balance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>balance</span></a> <a href="client_api.EthereumValidatorMetadata.html#effective_balance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>effective_<wbr/>balance</span></a> <a href="client_api.EthereumValidatorMetadata.html#exitEpoch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exit<wbr/>Epoch</span></a> @@ -11,18 +11,18 @@ <a href="client_api.EthereumValidatorMetadata.html#withdrawl_address" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>withdrawl_<wbr/>address</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="activationEpoch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>activation<wbr/>Epoch</span><a href="#activationEpoch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">activation<wbr/>Epoch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The epoch at which the validator was activated.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>EthereumValidatorMetadata</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L405">src/client/api.ts:405</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>balance</span><a href="#balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>EthereumValidatorMetadata</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L423">src/client/api.ts:423</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="effective_balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>effective_<wbr/>balance</span><a href="#effective_balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">effective_<wbr/>balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>EthereumValidatorMetadata</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L429">src/client/api.ts:429</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="exitEpoch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>exit<wbr/>Epoch</span><a href="#exitEpoch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">exit<wbr/>Epoch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The epoch at which the validator exited.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L405">src/client/api.ts:405</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>balance</span><a href="#balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>EthereumValidatorMetadata</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L423">src/client/api.ts:423</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="effective_balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>effective_<wbr/>balance</span><a href="#effective_balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">effective_<wbr/>balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>EthereumValidatorMetadata</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L429">src/client/api.ts:429</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="exitEpoch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>exit<wbr/>Epoch</span><a href="#exitEpoch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">exit<wbr/>Epoch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The epoch at which the validator exited.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>EthereumValidatorMetadata</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L411">src/client/api.ts:411</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="index" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>index</span><a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The index of the validator in the validator set.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L411">src/client/api.ts:411</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="index" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>index</span><a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The index of the validator in the validator set.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>EthereumValidatorMetadata</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L381">src/client/api.ts:381</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="public_key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>public_<wbr/>key</span><a href="#public_key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">public_<wbr/>key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The public key of the validator.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L381">src/client/api.ts:381</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="public_key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>public_<wbr/>key</span><a href="#public_key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">public_<wbr/>key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The public key of the validator.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>EthereumValidatorMetadata</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L387">src/client/api.ts:387</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="slashed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>slashed</span><a href="#slashed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">slashed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the validator has been slashed.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L387">src/client/api.ts:387</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="slashed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>slashed</span><a href="#slashed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">slashed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the validator has been slashed.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>EthereumValidatorMetadata</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L399">src/client/api.ts:399</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="withdrawableEpoch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>withdrawable<wbr/>Epoch</span><a href="#withdrawableEpoch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">withdrawable<wbr/>Epoch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The epoch at which the validator can withdraw.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L399">src/client/api.ts:399</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="withdrawableEpoch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>withdrawable<wbr/>Epoch</span><a href="#withdrawableEpoch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">withdrawable<wbr/>Epoch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The epoch at which the validator can withdraw.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>EthereumValidatorMetadata</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L417">src/client/api.ts:417</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="withdrawl_address" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>withdrawl_<wbr/>address</span><a href="#withdrawl_address" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">withdrawl_<wbr/>address</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The address to which the validator's rewards are sent.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L417">src/client/api.ts:417</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="withdrawl_address" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>withdrawl_<wbr/>address</span><a href="#withdrawl_address" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">withdrawl_<wbr/>address</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The address to which the validator's rewards are sent.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>EthereumValidatorMetadata</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L393">src/client/api.ts:393</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#activationEpoch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>activation<wbr/>Epoch</span></a><a href="#balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>balance</span></a><a href="#effective_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>effective_<wbr/>balance</span></a><a href="#exitEpoch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exit<wbr/>Epoch</span></a><a href="#index" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>index</span></a><a href="#public_key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>public_<wbr/>key</span></a><a href="#slashed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>slashed</span></a><a href="#withdrawableEpoch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>withdrawable<wbr/>Epoch</span></a><a href="#withdrawl_address" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>withdrawl_<wbr/>address</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L393">src/client/api.ts:393</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#activationEpoch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>activation<wbr/>Epoch</span></a><a href="#balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>balance</span></a><a href="#effective_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>effective_<wbr/>balance</span></a><a href="#exitEpoch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exit<wbr/>Epoch</span></a><a href="#index" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>index</span></a><a href="#public_key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>public_<wbr/>key</span></a><a href="#slashed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>slashed</span></a><a href="#withdrawableEpoch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>withdrawable<wbr/>Epoch</span></a><a href="#withdrawl_address" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>withdrawl_<wbr/>address</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.ExternalAddressesApiInterface.html b/docs/interfaces/client_api.ExternalAddressesApiInterface.html index 1d57b012..a4266d69 100644 --- a/docs/interfaces/client_api.ExternalAddressesApiInterface.html +++ b/docs/interfaces/client_api.ExternalAddressesApiInterface.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ExternalAddressesApiInterface | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ExternalAddressesApiInterface.html">ExternalAddressesApiInterface</a></li></ul><h1>Interface ExternalAddressesApiInterface</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ExternalAddressesApi - interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ExternalAddressesApi</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ExternalAddressesApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ExternalAddressesApiInterface.html#getExternalAddressBalance.getExternalAddressBalance-1">getExternalAddressBalance</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ExternalAddressesApiInterface.html#listExternalAddressBalances.listExternalAddressBalances-1">listExternalAddressBalances</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ExternalAddressesApiInterface.html#requestExternalFaucetFunds.requestExternalFaucetFunds-1">requestExternalFaucetFunds</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.ExternalAddressesApi.html" class="tsd-signature-type tsd-kind-class">ExternalAddressesApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2489">src/client/api.ts:2489</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.ExternalAddressesApiInterface.html#getExternalAddressBalance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Address<wbr/>Balance</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ExternalAddressesApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ExternalAddressesApiInterface.html#getExternalAddressBalance.getExternalAddressBalance-1">getExternalAddressBalance</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ExternalAddressesApiInterface.html#listExternalAddressBalances.listExternalAddressBalances-1">listExternalAddressBalances</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ExternalAddressesApiInterface.html#requestExternalFaucetFunds.requestExternalFaucetFunds-1">requestExternalFaucetFunds</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.ExternalAddressesApi.html" class="tsd-signature-type tsd-kind-class">ExternalAddressesApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2489">src/client/api.ts:2489</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.ExternalAddressesApiInterface.html#getExternalAddressBalance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Address<wbr/>Balance</span></a> <a href="client_api.ExternalAddressesApiInterface.html#listExternalAddressBalances" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>External<wbr/>Address<wbr/>Balances</span></a> <a href="client_api.ExternalAddressesApiInterface.html#requestExternalFaucetFunds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>External<wbr/>Faucet<wbr/>Funds</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getExternalAddressBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>External<wbr/>Address<wbr/>Balance</span><a href="#getExternalAddressBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getExternalAddressBalance.getExternalAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><a href="#getExternalAddressBalance.getExternalAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the balance of an asset in an external address</p> @@ -10,17 +10,17 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the balance of an asset in an external address</p> <h4>Throws</h4><h4>Memberof</h4><p>ExternalAddressesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2500">src/client/api.ts:2500</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listExternalAddressBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>External<wbr/>Address<wbr/>Balances</span><a href="#listExternalAddressBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listExternalAddressBalances.listExternalAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#listExternalAddressBalances.listExternalAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List all of the balances of an external address</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2500">src/client/api.ts:2500</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listExternalAddressBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>External<wbr/>Address<wbr/>Balances</span><a href="#listExternalAddressBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listExternalAddressBalances.listExternalAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#listExternalAddressBalances.listExternalAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List all of the balances of an external address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the balances of an external address</p> <h4>Throws</h4><h4>Memberof</h4><p>ExternalAddressesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2512">src/client/api.ts:2512</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="requestExternalFaucetFunds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><a href="#requestExternalFaucetFunds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="requestExternalFaucetFunds.requestExternalFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#requestExternalFaucetFunds.requestExternalFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to external address.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2512">src/client/api.ts:2512</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="requestExternalFaucetFunds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><a href="#requestExternalFaucetFunds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="requestExternalFaucetFunds.requestExternalFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#requestExternalFaucetFunds.requestExternalFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to external address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Request faucet funds for external address.</p> <h4>Throws</h4><h4>Memberof</h4><p>ExternalAddressesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2523">src/client/api.ts:2523</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#getExternalAddressBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Address<wbr/>Balance</span></a><a href="#listExternalAddressBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>External<wbr/>Address<wbr/>Balances</span></a><a href="#requestExternalFaucetFunds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>External<wbr/>Faucet<wbr/>Funds</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2523">src/client/api.ts:2523</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#getExternalAddressBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Address<wbr/>Balance</span></a><a href="#listExternalAddressBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>External<wbr/>Address<wbr/>Balances</span></a><a href="#requestExternalFaucetFunds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>External<wbr/>Faucet<wbr/>Funds</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.FaucetTransaction.html b/docs/interfaces/client_api.FaucetTransaction.html index e38ea907..ce0751e8 100644 --- a/docs/interfaces/client_api.FaucetTransaction.html +++ b/docs/interfaces/client_api.FaucetTransaction.html @@ -1,9 +1,9 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FaucetTransaction | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.FaucetTransaction.html">FaucetTransaction</a></li></ul><h1>Interface FaucetTransaction</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The faucet transaction</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>FaucetTransaction</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">FaucetTransaction</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FaucetTransaction.html#transaction_hash">transaction_hash</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FaucetTransaction.html#transaction_link">transaction_link</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L436">src/client/api.ts:436</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.FaucetTransaction.html#transaction_hash" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>hash</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">FaucetTransaction</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FaucetTransaction.html#transaction_hash">transaction_hash</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FaucetTransaction.html#transaction_link">transaction_link</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L436">src/client/api.ts:436</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.FaucetTransaction.html#transaction_hash" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>hash</span></a> <a href="client_api.FaucetTransaction.html#transaction_link" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>link</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="transaction_hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction_<wbr/>hash</span><a href="#transaction_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>hash</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The transaction hash of the transaction the faucet created.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>FaucetTransaction</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L442">src/client/api.ts:442</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_link" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction_<wbr/>link</span><a href="#transaction_link" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>link</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Link to the transaction on the blockchain explorer.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L442">src/client/api.ts:442</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_link" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction_<wbr/>link</span><a href="#transaction_link" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>link</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Link to the transaction on the blockchain explorer.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>FaucetTransaction</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L448">src/client/api.ts:448</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#transaction_hash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>hash</span></a><a href="#transaction_link" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>link</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L448">src/client/api.ts:448</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#transaction_hash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>hash</span></a><a href="#transaction_link" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>link</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.FetchStakingRewards200Response.html b/docs/interfaces/client_api.FetchStakingRewards200Response.html index 5f4591cd..2b149d4c 100644 --- a/docs/interfaces/client_api.FetchStakingRewards200Response.html +++ b/docs/interfaces/client_api.FetchStakingRewards200Response.html @@ -1,10 +1,10 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FetchStakingRewards200Response | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.FetchStakingRewards200Response.html">FetchStakingRewards200Response</a></li></ul><h1>Interface FetchStakingRewards200Response</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>FetchStakingRewards200Response</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">FetchStakingRewards200Response</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewards200Response.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.StakingReward.html" class="tsd-signature-type tsd-kind-interface">StakingReward</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewards200Response.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewards200Response.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L471">src/client/api.ts:471</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.FetchStakingRewards200Response.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">FetchStakingRewards200Response</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewards200Response.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.StakingReward.html" class="tsd-signature-type tsd-kind-interface">StakingReward</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewards200Response.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewards200Response.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L471">src/client/api.ts:471</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.FetchStakingRewards200Response.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> <a href="client_api.FetchStakingRewards200Response.html#has_more" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a> <a href="client_api.FetchStakingRewards200Response.html#next_page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <a href="client_api.StakingReward.html" class="tsd-signature-type tsd-kind-interface">StakingReward</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>FetchStakingRewards200Response</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L477">src/client/api.ts:477</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L477">src/client/api.ts:477</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>FetchStakingRewards200Response</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L483">src/client/api.ts:483</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L483">src/client/api.ts:483</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>FetchStakingRewards200Response</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L489">src/client/api.ts:489</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L489">src/client/api.ts:489</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.FetchStakingRewardsRequest.html b/docs/interfaces/client_api.FetchStakingRewardsRequest.html index 9ab41119..acf5ded1 100644 --- a/docs/interfaces/client_api.FetchStakingRewardsRequest.html +++ b/docs/interfaces/client_api.FetchStakingRewardsRequest.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FetchStakingRewardsRequest | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.FetchStakingRewardsRequest.html">FetchStakingRewardsRequest</a></li></ul><h1>Interface FetchStakingRewardsRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>FetchStakingRewardsRequest</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">FetchStakingRewardsRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewardsRequest.html#address_ids">address_ids</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewardsRequest.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewardsRequest.html#end_time">end_time</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewardsRequest.html#format">format</a><span class="tsd-signature-symbol">: </span><a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewardsRequest.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewardsRequest.html#start_time">start_time</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L496">src/client/api.ts:496</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.FetchStakingRewardsRequest.html#address_ids" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>ids</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">FetchStakingRewardsRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewardsRequest.html#address_ids">address_ids</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewardsRequest.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewardsRequest.html#end_time">end_time</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewardsRequest.html#format">format</a><span class="tsd-signature-symbol">: </span><a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewardsRequest.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.FetchStakingRewardsRequest.html#start_time">start_time</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L496">src/client/api.ts:496</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.FetchStakingRewardsRequest.html#address_ids" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>ids</span></a> <a href="client_api.FetchStakingRewardsRequest.html#asset_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a> <a href="client_api.FetchStakingRewardsRequest.html#end_time" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>end_<wbr/>time</span></a> <a href="client_api.FetchStakingRewardsRequest.html#format" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>format</span></a> @@ -7,13 +7,13 @@ <a href="client_api.FetchStakingRewardsRequest.html#start_time" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start_<wbr/>time</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="address_ids" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>ids</span><a href="#address_ids" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The onchain addresses for which the staking rewards are being fetched</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>FetchStakingRewardsRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L514">src/client/api.ts:514</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset_<wbr/>id</span><a href="#asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset for which the staking rewards are being fetched</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L514">src/client/api.ts:514</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset_<wbr/>id</span><a href="#asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset for which the staking rewards are being fetched</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>FetchStakingRewardsRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L508">src/client/api.ts:508</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="end_time" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>end_<wbr/>time</span><a href="#end_time" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">end_<wbr/>time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The end time of this reward period</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L508">src/client/api.ts:508</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="end_time" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>end_<wbr/>time</span><a href="#end_time" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">end_<wbr/>time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The end time of this reward period</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>FetchStakingRewardsRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L526">src/client/api.ts:526</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="format" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>format</span><a href="#format" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>FetchStakingRewardsRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L532">src/client/api.ts:532</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L526">src/client/api.ts:526</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="format" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>format</span><a href="#format" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>FetchStakingRewardsRequest</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L532">src/client/api.ts:532</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>FetchStakingRewardsRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L502">src/client/api.ts:502</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="start_time" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start_<wbr/>time</span><a href="#start_time" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">start_<wbr/>time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The start time of this reward period</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L502">src/client/api.ts:502</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="start_time" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start_<wbr/>time</span><a href="#start_time" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">start_<wbr/>time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The start time of this reward period</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>FetchStakingRewardsRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L520">src/client/api.ts:520</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_ids" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>ids</span></a><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#end_time" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>end_<wbr/>time</span></a><a href="#format" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>format</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#start_time" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start_<wbr/>time</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L520">src/client/api.ts:520</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_ids" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>ids</span></a><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#end_time" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>end_<wbr/>time</span></a><a href="#format" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>format</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#start_time" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start_<wbr/>time</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.GetStakingContextRequest.html b/docs/interfaces/client_api.GetStakingContextRequest.html index a0443f56..2b71b42d 100644 --- a/docs/interfaces/client_api.GetStakingContextRequest.html +++ b/docs/interfaces/client_api.GetStakingContextRequest.html @@ -1,13 +1,13 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GetStakingContextRequest | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.GetStakingContextRequest.html">GetStakingContextRequest</a></li></ul><h1>Interface GetStakingContextRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>GetStakingContextRequest</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">GetStakingContextRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.GetStakingContextRequest.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.GetStakingContextRequest.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.GetStakingContextRequest.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.GetStakingContextRequest.html#options">options</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L541">src/client/api.ts:541</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.GetStakingContextRequest.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">GetStakingContextRequest</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.GetStakingContextRequest.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.GetStakingContextRequest.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.GetStakingContextRequest.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.GetStakingContextRequest.html#options">options</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L541">src/client/api.ts:541</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.GetStakingContextRequest.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> <a href="client_api.GetStakingContextRequest.html#asset_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a> <a href="client_api.GetStakingContextRequest.html#network_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a> <a href="client_api.GetStakingContextRequest.html#options" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="address_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>id</span><a href="#address_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The onchain address for which the staking context is being fetched</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>GetStakingContextRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L559">src/client/api.ts:559</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset_<wbr/>id</span><a href="#asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset being staked</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L559">src/client/api.ts:559</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset_<wbr/>id</span><a href="#asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset being staked</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>GetStakingContextRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L553">src/client/api.ts:553</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L553">src/client/api.ts:553</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>GetStakingContextRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L547">src/client/api.ts:547</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>GetStakingContextRequest</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L565">src/client/api.ts:565</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#options" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L547">src/client/api.ts:547</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>GetStakingContextRequest</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L565">src/client/api.ts:565</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#options" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.ModelError.html b/docs/interfaces/client_api.ModelError.html index f22909bb..f8069378 100644 --- a/docs/interfaces/client_api.ModelError.html +++ b/docs/interfaces/client_api.ModelError.html @@ -1,9 +1,9 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ModelError | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ModelError.html">ModelError</a></li></ul><h1>Interface ModelError</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An error response from the Coinbase Developer Platform API</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ModelError</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ModelError</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ModelError.html#code">code</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ModelError.html#message">message</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L572">src/client/api.ts:572</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ModelError.html#code" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ModelError</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ModelError.html#code">code</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ModelError.html#message">message</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L572">src/client/api.ts:572</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ModelError.html#code" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a> <a href="client_api.ModelError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A short string representing the reported error. Can be use to handle errors programmatically.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ModelError</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L578">src/client/api.ts:578</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A human-readable message providing more details about the error.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L578">src/client/api.ts:578</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A human-readable message providing more details about the error.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ModelError</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L584">src/client/api.ts:584</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#code" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#message" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L584">src/client/api.ts:584</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#code" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#message" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.NativeEthStakingContext.html b/docs/interfaces/client_api.NativeEthStakingContext.html index 84efefa4..06d684ac 100644 --- a/docs/interfaces/client_api.NativeEthStakingContext.html +++ b/docs/interfaces/client_api.NativeEthStakingContext.html @@ -1,9 +1,9 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NativeEthStakingContext | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.NativeEthStakingContext.html">NativeEthStakingContext</a></li></ul><h1>Interface NativeEthStakingContext</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The native eth staking context.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>NativeEthStakingContext</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">NativeEthStakingContext</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.NativeEthStakingContext.html#claimable_balance">claimable_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.NativeEthStakingContext.html#stakeable_balance">stakeable_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.NativeEthStakingContext.html#unstakeable_balance">unstakeable_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L591">src/client/api.ts:591</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.NativeEthStakingContext.html#claimable_balance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>claimable_<wbr/>balance</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">NativeEthStakingContext</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.NativeEthStakingContext.html#claimable_balance">claimable_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.NativeEthStakingContext.html#stakeable_balance">stakeable_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.NativeEthStakingContext.html#unstakeable_balance">unstakeable_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L591">src/client/api.ts:591</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.NativeEthStakingContext.html#claimable_balance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>claimable_<wbr/>balance</span></a> <a href="client_api.NativeEthStakingContext.html#stakeable_balance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stakeable_<wbr/>balance</span></a> <a href="client_api.NativeEthStakingContext.html#unstakeable_balance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unstakeable_<wbr/>balance</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="claimable_balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>claimable_<wbr/>balance</span><a href="#claimable_balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">claimable_<wbr/>balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>NativeEthStakingContext</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L609">src/client/api.ts:609</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="stakeable_balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stakeable_<wbr/>balance</span><a href="#stakeable_balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stakeable_<wbr/>balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>NativeEthStakingContext</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L597">src/client/api.ts:597</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unstakeable_balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unstakeable_<wbr/>balance</span><a href="#unstakeable_balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unstakeable_<wbr/>balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>NativeEthStakingContext</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L603">src/client/api.ts:603</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#claimable_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>claimable_<wbr/>balance</span></a><a href="#stakeable_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stakeable_<wbr/>balance</span></a><a href="#unstakeable_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unstakeable_<wbr/>balance</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L609">src/client/api.ts:609</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="stakeable_balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stakeable_<wbr/>balance</span><a href="#stakeable_balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stakeable_<wbr/>balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>NativeEthStakingContext</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L597">src/client/api.ts:597</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unstakeable_balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unstakeable_<wbr/>balance</span><a href="#unstakeable_balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unstakeable_<wbr/>balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>NativeEthStakingContext</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L603">src/client/api.ts:603</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#claimable_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>claimable_<wbr/>balance</span></a><a href="#stakeable_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stakeable_<wbr/>balance</span></a><a href="#unstakeable_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unstakeable_<wbr/>balance</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.PartialEthStakingContext.html b/docs/interfaces/client_api.PartialEthStakingContext.html index 0023abb4..82f8a11b 100644 --- a/docs/interfaces/client_api.PartialEthStakingContext.html +++ b/docs/interfaces/client_api.PartialEthStakingContext.html @@ -1,9 +1,9 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PartialEthStakingContext | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.PartialEthStakingContext.html">PartialEthStakingContext</a></li></ul><h1>Interface PartialEthStakingContext</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The partial eth staking context.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>PartialEthStakingContext</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">PartialEthStakingContext</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.PartialEthStakingContext.html#claimable_balance">claimable_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.PartialEthStakingContext.html#stakeable_balance">stakeable_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.PartialEthStakingContext.html#unstakeable_balance">unstakeable_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L616">src/client/api.ts:616</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.PartialEthStakingContext.html#claimable_balance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>claimable_<wbr/>balance</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">PartialEthStakingContext</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.PartialEthStakingContext.html#claimable_balance">claimable_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.PartialEthStakingContext.html#stakeable_balance">stakeable_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.PartialEthStakingContext.html#unstakeable_balance">unstakeable_balance</a><span class="tsd-signature-symbol">: </span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L616">src/client/api.ts:616</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.PartialEthStakingContext.html#claimable_balance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>claimable_<wbr/>balance</span></a> <a href="client_api.PartialEthStakingContext.html#stakeable_balance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stakeable_<wbr/>balance</span></a> <a href="client_api.PartialEthStakingContext.html#unstakeable_balance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unstakeable_<wbr/>balance</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="claimable_balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>claimable_<wbr/>balance</span><a href="#claimable_balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">claimable_<wbr/>balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>PartialEthStakingContext</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L634">src/client/api.ts:634</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="stakeable_balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stakeable_<wbr/>balance</span><a href="#stakeable_balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stakeable_<wbr/>balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>PartialEthStakingContext</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L622">src/client/api.ts:622</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unstakeable_balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unstakeable_<wbr/>balance</span><a href="#unstakeable_balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unstakeable_<wbr/>balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>PartialEthStakingContext</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L628">src/client/api.ts:628</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#claimable_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>claimable_<wbr/>balance</span></a><a href="#stakeable_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stakeable_<wbr/>balance</span></a><a href="#unstakeable_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unstakeable_<wbr/>balance</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L634">src/client/api.ts:634</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="stakeable_balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stakeable_<wbr/>balance</span><a href="#stakeable_balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stakeable_<wbr/>balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>PartialEthStakingContext</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L622">src/client/api.ts:622</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unstakeable_balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unstakeable_<wbr/>balance</span><a href="#unstakeable_balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unstakeable_<wbr/>balance</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>PartialEthStakingContext</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L628">src/client/api.ts:628</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#claimable_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>claimable_<wbr/>balance</span></a><a href="#stakeable_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stakeable_<wbr/>balance</span></a><a href="#unstakeable_balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unstakeable_<wbr/>balance</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.SeedCreationEvent.html b/docs/interfaces/client_api.SeedCreationEvent.html index 4cc5fc38..ad3eaf0a 100644 --- a/docs/interfaces/client_api.SeedCreationEvent.html +++ b/docs/interfaces/client_api.SeedCreationEvent.html @@ -1,9 +1,9 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SeedCreationEvent | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.SeedCreationEvent.html">SeedCreationEvent</a></li></ul><h1>Interface SeedCreationEvent</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An event representing a seed creation.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>SeedCreationEvent</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SeedCreationEvent</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SeedCreationEvent.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SeedCreationEvent.html#wallet_user_id">wallet_user_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L641">src/client/api.ts:641</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.SeedCreationEvent.html#wallet_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SeedCreationEvent</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SeedCreationEvent.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SeedCreationEvent.html#wallet_user_id">wallet_user_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L641">src/client/api.ts:641</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.SeedCreationEvent.html#wallet_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a> <a href="client_api.SeedCreationEvent.html#wallet_user_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>user_<wbr/>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet that the server-signer should create the seed for</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SeedCreationEvent</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L647">src/client/api.ts:647</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_user_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>user_<wbr/>id</span><a href="#wallet_user_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>user_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the user that the wallet belongs to</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L647">src/client/api.ts:647</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_user_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>user_<wbr/>id</span><a href="#wallet_user_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>user_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the user that the wallet belongs to</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SeedCreationEvent</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L653">src/client/api.ts:653</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a><a href="#wallet_user_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>user_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L653">src/client/api.ts:653</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a><a href="#wallet_user_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>user_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.SeedCreationEventResult.html b/docs/interfaces/client_api.SeedCreationEventResult.html index f4881305..22c48b91 100644 --- a/docs/interfaces/client_api.SeedCreationEventResult.html +++ b/docs/interfaces/client_api.SeedCreationEventResult.html @@ -1,15 +1,15 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SeedCreationEventResult | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.SeedCreationEventResult.html">SeedCreationEventResult</a></li></ul><h1>Interface SeedCreationEventResult</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The result to a SeedCreationEvent.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>SeedCreationEventResult</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SeedCreationEventResult</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SeedCreationEventResult.html#extended_public_key">extended_public_key</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SeedCreationEventResult.html#seed_id">seed_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SeedCreationEventResult.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SeedCreationEventResult.html#wallet_user_id">wallet_user_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L660">src/client/api.ts:660</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.SeedCreationEventResult.html#extended_public_key" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extended_<wbr/>public_<wbr/>key</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SeedCreationEventResult</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SeedCreationEventResult.html#extended_public_key">extended_public_key</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SeedCreationEventResult.html#seed_id">seed_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SeedCreationEventResult.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SeedCreationEventResult.html#wallet_user_id">wallet_user_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L660">src/client/api.ts:660</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.SeedCreationEventResult.html#extended_public_key" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extended_<wbr/>public_<wbr/>key</span></a> <a href="client_api.SeedCreationEventResult.html#seed_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>seed_<wbr/>id</span></a> <a href="client_api.SeedCreationEventResult.html#wallet_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a> <a href="client_api.SeedCreationEventResult.html#wallet_user_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>user_<wbr/>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="extended_public_key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>extended_<wbr/>public_<wbr/>key</span><a href="#extended_public_key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">extended_<wbr/>public_<wbr/>key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The extended public key for the first master key derived from seed.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SeedCreationEventResult</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L678">src/client/api.ts:678</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="seed_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>seed_<wbr/>id</span><a href="#seed_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">seed_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the seed in Server-Signer used to generate the extended public key.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L678">src/client/api.ts:678</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="seed_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>seed_<wbr/>id</span><a href="#seed_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">seed_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the seed in Server-Signer used to generate the extended public key.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SeedCreationEventResult</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L684">src/client/api.ts:684</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet that the seed was created for</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L684">src/client/api.ts:684</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet that the seed was created for</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SeedCreationEventResult</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L666">src/client/api.ts:666</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_user_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>user_<wbr/>id</span><a href="#wallet_user_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>user_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the user that the wallet belongs to</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L666">src/client/api.ts:666</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_user_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>user_<wbr/>id</span><a href="#wallet_user_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>user_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the user that the wallet belongs to</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SeedCreationEventResult</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L672">src/client/api.ts:672</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#extended_public_key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extended_<wbr/>public_<wbr/>key</span></a><a href="#seed_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>seed_<wbr/>id</span></a><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a><a href="#wallet_user_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>user_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L672">src/client/api.ts:672</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#extended_public_key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extended_<wbr/>public_<wbr/>key</span></a><a href="#seed_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>seed_<wbr/>id</span></a><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a><a href="#wallet_user_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>user_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSigner.html b/docs/interfaces/client_api.ServerSigner.html index 552f1ab5..4a36c54a 100644 --- a/docs/interfaces/client_api.ServerSigner.html +++ b/docs/interfaces/client_api.ServerSigner.html @@ -1,12 +1,12 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerSigner | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ServerSigner.html">ServerSigner</a></li></ul><h1>Interface ServerSigner</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A Server-Signer assigned to sign transactions in a wallet.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ServerSigner</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ServerSigner</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSigner.html#is_mpc">is_mpc</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSigner.html#server_signer_id">server_signer_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSigner.html#wallets">wallets</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L691">src/client/api.ts:691</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ServerSigner.html#is_mpc" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>mpc</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ServerSigner</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSigner.html#is_mpc">is_mpc</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSigner.html#server_signer_id">server_signer_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSigner.html#wallets">wallets</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L691">src/client/api.ts:691</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ServerSigner.html#is_mpc" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>mpc</span></a> <a href="client_api.ServerSigner.html#server_signer_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server_<wbr/>signer_<wbr/>id</span></a> <a href="client_api.ServerSigner.html#wallets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallets?</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="is_mpc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is_<wbr/>mpc</span><a href="#is_mpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is_<wbr/>mpc</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the Server-Signer uses MPC.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSigner</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L709">src/client/api.ts:709</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="server_signer_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>server_<wbr/>signer_<wbr/>id</span><a href="#server_signer_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">server_<wbr/>signer_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the server-signer</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L709">src/client/api.ts:709</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="server_signer_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>server_<wbr/>signer_<wbr/>id</span><a href="#server_signer_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">server_<wbr/>signer_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the server-signer</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSigner</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L697">src/client/api.ts:697</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>wallets</span><a href="#wallets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallets</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The IDs of the wallets that the server-signer can sign for</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L697">src/client/api.ts:697</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>wallets</span><a href="#wallets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallets</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The IDs of the wallets that the server-signer can sign for</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSigner</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L703">src/client/api.ts:703</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#is_mpc" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>mpc</span></a><a href="#server_signer_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server_<wbr/>signer_<wbr/>id</span></a><a href="#wallets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallets</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L703">src/client/api.ts:703</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#is_mpc" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>mpc</span></a><a href="#server_signer_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server_<wbr/>signer_<wbr/>id</span></a><a href="#wallets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallets</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignerEvent.html b/docs/interfaces/client_api.ServerSignerEvent.html index 529ebe1b..e1d5a763 100644 --- a/docs/interfaces/client_api.ServerSignerEvent.html +++ b/docs/interfaces/client_api.ServerSignerEvent.html @@ -1,8 +1,8 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerSignerEvent | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ServerSignerEvent.html">ServerSignerEvent</a></li></ul><h1>Interface ServerSignerEvent</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An event that is waiting to be processed by a Server-Signer.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ServerSignerEvent</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ServerSignerEvent</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerEvent.html#event">event</a><span class="tsd-signature-symbol">: </span><a href="../types/client_api.ServerSignerEventEvent.html" class="tsd-signature-type tsd-kind-type-alias">ServerSignerEventEvent</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerEvent.html#server_signer_id">server_signer_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L716">src/client/api.ts:716</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ServerSignerEvent.html#event" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ServerSignerEvent</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerEvent.html#event">event</a><span class="tsd-signature-symbol">: </span><a href="../types/client_api.ServerSignerEventEvent.html" class="tsd-signature-type tsd-kind-type-alias">ServerSignerEventEvent</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerEvent.html#server_signer_id">server_signer_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L716">src/client/api.ts:716</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ServerSignerEvent.html#event" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event</span></a> <a href="client_api.ServerSignerEvent.html#server_signer_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server_<wbr/>signer_<wbr/>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="event" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>event</span><a href="#event" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">event</span><span class="tsd-signature-symbol">:</span> <a href="../types/client_api.ServerSignerEventEvent.html" class="tsd-signature-type tsd-kind-type-alias">ServerSignerEventEvent</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSignerEvent</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L728">src/client/api.ts:728</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="server_signer_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>server_<wbr/>signer_<wbr/>id</span><a href="#server_signer_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">server_<wbr/>signer_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the server-signer that the event is for</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L728">src/client/api.ts:728</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="server_signer_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>server_<wbr/>signer_<wbr/>id</span><a href="#server_signer_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">server_<wbr/>signer_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the server-signer that the event is for</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSignerEvent</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L722">src/client/api.ts:722</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#event" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event</span></a><a href="#server_signer_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server_<wbr/>signer_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L722">src/client/api.ts:722</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#event" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event</span></a><a href="#server_signer_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server_<wbr/>signer_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignerEventList.html b/docs/interfaces/client_api.ServerSignerEventList.html index a2cbf996..a7e94ad3 100644 --- a/docs/interfaces/client_api.ServerSignerEventList.html +++ b/docs/interfaces/client_api.ServerSignerEventList.html @@ -1,13 +1,13 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerSignerEventList | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ServerSignerEventList.html">ServerSignerEventList</a></li></ul><h1>Interface ServerSignerEventList</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ServerSignerEventList</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ServerSignerEventList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerEventList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.ServerSignerEvent.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEvent</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerEventList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerEventList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerEventList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L741">src/client/api.ts:741</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ServerSignerEventList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ServerSignerEventList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerEventList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.ServerSignerEvent.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEvent</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerEventList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerEventList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerEventList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L741">src/client/api.ts:741</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ServerSignerEventList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> <a href="client_api.ServerSignerEventList.html#has_more" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a> <a href="client_api.ServerSignerEventList.html#next_page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a> <a href="client_api.ServerSignerEventList.html#total_count" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <a href="client_api.ServerSignerEvent.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEvent</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSignerEventList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L747">src/client/api.ts:747</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L747">src/client/api.ts:747</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSignerEventList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L753">src/client/api.ts:753</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L753">src/client/api.ts:753</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSignerEventList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L759">src/client/api.ts:759</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of events for the server signer.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L759">src/client/api.ts:759</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of events for the server signer.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSignerEventList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L765">src/client/api.ts:765</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L765">src/client/api.ts:765</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignerList.html b/docs/interfaces/client_api.ServerSignerList.html index 9de0f8ba..f61c0730 100644 --- a/docs/interfaces/client_api.ServerSignerList.html +++ b/docs/interfaces/client_api.ServerSignerList.html @@ -1,13 +1,13 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerSignerList | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ServerSignerList.html">ServerSignerList</a></li></ul><h1>Interface ServerSignerList</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ServerSignerList</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ServerSignerList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L772">src/client/api.ts:772</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ServerSignerList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ServerSignerList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ServerSignerList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L772">src/client/api.ts:772</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ServerSignerList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> <a href="client_api.ServerSignerList.html#has_more" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a> <a href="client_api.ServerSignerList.html#next_page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a> <a href="client_api.ServerSignerList.html#total_count" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <a href="client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSignerList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L778">src/client/api.ts:778</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L778">src/client/api.ts:778</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSignerList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L784">src/client/api.ts:784</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L784">src/client/api.ts:784</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSignerList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L790">src/client/api.ts:790</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of server-signers for the project.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L790">src/client/api.ts:790</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of server-signers for the project.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ServerSignerList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L796">src/client/api.ts:796</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L796">src/client/api.ts:796</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignersApiInterface.html b/docs/interfaces/client_api.ServerSignersApiInterface.html index 86e232a7..4f50cfa3 100644 --- a/docs/interfaces/client_api.ServerSignersApiInterface.html +++ b/docs/interfaces/client_api.ServerSignersApiInterface.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerSignersApiInterface | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ServerSignersApiInterface.html">ServerSignersApiInterface</a></li></ul><h1>Interface ServerSignersApiInterface</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ServerSignersApi - interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ServerSignersApi</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ServerSignersApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ServerSignersApiInterface.html#createServerSigner.createServerSigner-1">createServerSigner</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createServerSignerRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ServerSignersApiInterface.html#getServerSigner.getServerSigner-1">getServerSigner</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ServerSignersApiInterface.html#listServerSignerEvents.listServerSignerEvents-1">listServerSignerEvents</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ServerSignersApiInterface.html#listServerSigners.listServerSigners-1">listServerSigners</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ServerSignersApiInterface.html#submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1">submitServerSignerSeedEventResult</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">seedCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ServerSignersApiInterface.html#submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1">submitServerSignerSignatureEventResult</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.ServerSignersApi.html" class="tsd-signature-type tsd-kind-class">ServerSignersApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2988">src/client/api.ts:2988</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.ServerSignersApiInterface.html#createServerSigner" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Server<wbr/>Signer</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ServerSignersApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ServerSignersApiInterface.html#createServerSigner.createServerSigner-1">createServerSigner</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createServerSignerRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ServerSignersApiInterface.html#getServerSigner.getServerSigner-1">getServerSigner</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ServerSignersApiInterface.html#listServerSignerEvents.listServerSignerEvents-1">listServerSignerEvents</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ServerSignersApiInterface.html#listServerSigners.listServerSigners-1">listServerSigners</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ServerSignersApiInterface.html#submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1">submitServerSignerSeedEventResult</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">seedCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ServerSignersApiInterface.html#submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1">submitServerSignerSignatureEventResult</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.ServerSignersApi.html" class="tsd-signature-type tsd-kind-class">ServerSignersApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2988">src/client/api.ts:2988</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.ServerSignersApiInterface.html#createServerSigner" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Server<wbr/>Signer</span></a> <a href="client_api.ServerSignersApiInterface.html#getServerSigner" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Server<wbr/>Signer</span></a> <a href="client_api.ServerSignersApiInterface.html#listServerSignerEvents" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Server<wbr/>Signer<wbr/>Events</span></a> <a href="client_api.ServerSignersApiInterface.html#listServerSigners" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Server<wbr/>Signers</span></a> @@ -10,32 +10,32 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createServerSignerRequest</span>: <a href="client_api.CreateServerSignerRequest.html" class="tsd-signature-type tsd-kind-interface">CreateServerSignerRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new Server-Signer</p> <h4>Throws</h4><h4>Memberof</h4><p>ServerSignersApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L2997">src/client/api.ts:2997</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getServerSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Server<wbr/>Signer</span><a href="#getServerSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getServerSigner.getServerSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><a href="#getServerSigner.getServerSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a server signer by ID</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L2997">src/client/api.ts:2997</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getServerSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Server<wbr/>Signer</span><a href="#getServerSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getServerSigner.getServerSigner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span><a href="#getServerSigner.getServerSigner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a server signer by ID</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSigner.html" class="tsd-signature-type tsd-kind-interface">ServerSigner</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a server signer by ID</p> <h4>Throws</h4><h4>Memberof</h4><p>ServerSignersApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3007">src/client/api.ts:3007</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listServerSignerEvents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Server<wbr/>Signer<wbr/>Events</span><a href="#listServerSignerEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listServerSignerEvents.listServerSignerEvents-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signer<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span><a href="#listServerSignerEvents.listServerSignerEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List events for a server signer</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3007">src/client/api.ts:3007</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listServerSignerEvents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Server<wbr/>Signer<wbr/>Events</span><a href="#listServerSignerEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listServerSignerEvents.listServerSignerEvents-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signer<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span><a href="#listServerSignerEvents.listServerSignerEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List events for a server signer</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to fetch events for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSignerEventList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerEventList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List events for a server signer</p> <h4>Throws</h4><h4>Memberof</h4><p>ServerSignersApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3019">src/client/api.ts:3019</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listServerSigners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Server<wbr/>Signers</span><a href="#listServerSigners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listServerSigners.listServerSigners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span><a href="#listServerSigners.listServerSigners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List server signers for the current project</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3019">src/client/api.ts:3019</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listServerSigners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Server<wbr/>Signers</span><a href="#listServerSigners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listServerSigners.listServerSigners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Server<wbr/>Signers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span><a href="#listServerSigners.listServerSigners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List server signers for the current project</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ServerSignerList.html" class="tsd-signature-type tsd-kind-interface">ServerSignerList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List server signers for the current project</p> <h4>Throws</h4><h4>Memberof</h4><p>ServerSignersApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3030">src/client/api.ts:3030</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="submitServerSignerSeedEventResult" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><a href="#submitServerSignerSeedEventResult" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">seedCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span><a href="#submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3030">src/client/api.ts:3030</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="submitServerSignerSeedEventResult" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><a href="#submitServerSignerSeedEventResult" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">seedCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span><a href="#submitServerSignerSeedEventResult.submitServerSignerSeedEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to submit the event result for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">seedCreationEventResult</span>: <a href="client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.SeedCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEventResult</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Submit the result of a server signer event</p> <h4>Throws</h4><h4>Memberof</h4><p>ServerSignersApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3041">src/client/api.ts:3041</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="submitServerSignerSignatureEventResult" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><a href="#submitServerSignerSignatureEventResult" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span><a href="#submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3041">src/client/api.ts:3041</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="submitServerSignerSignatureEventResult" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><a href="#submitServerSignerSignatureEventResult" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serverSignerId</span>, <span class="tsd-kind-parameter">signatureCreationEventResult</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span><a href="#submitServerSignerSignatureEventResult.submitServerSignerSignatureEventResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit the result of a server signer event</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">serverSignerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the server signer to submit the event result for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">signatureCreationEventResult</span>: <a href="client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.SignatureCreationEventResult.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEventResult</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Submit the result of a server signer event</p> <h4>Throws</h4><h4>Memberof</h4><p>ServerSignersApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3052">src/client/api.ts:3052</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#createServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Server<wbr/>Signer</span></a><a href="#getServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Server<wbr/>Signer</span></a><a href="#listServerSignerEvents" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Server<wbr/>Signer<wbr/>Events</span></a><a href="#listServerSigners" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Server<wbr/>Signers</span></a><a href="#submitServerSignerSeedEventResult" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span></a><a href="#submitServerSignerSignatureEventResult" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3052">src/client/api.ts:3052</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#createServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Server<wbr/>Signer</span></a><a href="#getServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Server<wbr/>Signer</span></a><a href="#listServerSignerEvents" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Server<wbr/>Signer<wbr/>Events</span></a><a href="#listServerSigners" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Server<wbr/>Signers</span></a><a href="#submitServerSignerSeedEventResult" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Server<wbr/>Signer<wbr/>Seed<wbr/>Event<wbr/>Result</span></a><a href="#submitServerSignerSignatureEventResult" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Server<wbr/>Signer<wbr/>Signature<wbr/>Event<wbr/>Result</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.SignatureCreationEvent.html b/docs/interfaces/client_api.SignatureCreationEvent.html index 2626a83b..3144995d 100644 --- a/docs/interfaces/client_api.SignatureCreationEvent.html +++ b/docs/interfaces/client_api.SignatureCreationEvent.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SignatureCreationEvent | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.SignatureCreationEvent.html">SignatureCreationEvent</a></li></ul><h1>Interface SignatureCreationEvent</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An event representing a signature creation.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>SignatureCreationEvent</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SignatureCreationEvent</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#address_index">address_index</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#seed_id">seed_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#signing_payload">signing_payload</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#transaction_id">transaction_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#transaction_type">transaction_type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"transfer"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#wallet_user_id">wallet_user_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L803">src/client/api.ts:803</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.SignatureCreationEvent.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SignatureCreationEvent</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#address_index">address_index</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#seed_id">seed_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#signing_payload">signing_payload</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#transaction_id">transaction_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#transaction_type">transaction_type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"transfer"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEvent.html#wallet_user_id">wallet_user_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L803">src/client/api.ts:803</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.SignatureCreationEvent.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> <a href="client_api.SignatureCreationEvent.html#address_index" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>index</span></a> <a href="client_api.SignatureCreationEvent.html#seed_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>seed_<wbr/>id</span></a> <a href="client_api.SignatureCreationEvent.html#signing_payload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signing_<wbr/>payload</span></a> @@ -10,17 +10,17 @@ <a href="client_api.SignatureCreationEvent.html#wallet_user_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>user_<wbr/>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="address_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>id</span><a href="#address_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the address the transfer belongs to</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEvent</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L827">src/client/api.ts:827</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="address_index" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>index</span><a href="#address_index" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The index of the address that the server-signer should sign with</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L827">src/client/api.ts:827</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="address_index" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>index</span><a href="#address_index" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The index of the address that the server-signer should sign with</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEvent</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L833">src/client/api.ts:833</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="seed_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>seed_<wbr/>id</span><a href="#seed_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">seed_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the seed that the server-signer should create the signature for</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L833">src/client/api.ts:833</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="seed_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>seed_<wbr/>id</span><a href="#seed_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">seed_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the seed that the server-signer should create the signature for</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEvent</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L809">src/client/api.ts:809</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="signing_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>signing_<wbr/>payload</span><a href="#signing_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signing_<wbr/>payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The payload that the server-signer should sign</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L809">src/client/api.ts:809</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="signing_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>signing_<wbr/>payload</span><a href="#signing_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signing_<wbr/>payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The payload that the server-signer should sign</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEvent</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L839">src/client/api.ts:839</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction_<wbr/>id</span><a href="#transaction_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the transaction that the server-signer should sign</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L839">src/client/api.ts:839</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction_<wbr/>id</span><a href="#transaction_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the transaction that the server-signer should sign</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEvent</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L851">src/client/api.ts:851</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction_<wbr/>type</span><a href="#transaction_type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"transfer"</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEvent</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L845">src/client/api.ts:845</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet the signature is for</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L851">src/client/api.ts:851</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction_<wbr/>type</span><a href="#transaction_type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"transfer"</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEvent</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L845">src/client/api.ts:845</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet the signature is for</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEvent</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L815">src/client/api.ts:815</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_user_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>user_<wbr/>id</span><a href="#wallet_user_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>user_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the user that the wallet belongs to</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L815">src/client/api.ts:815</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_user_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>user_<wbr/>id</span><a href="#wallet_user_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>user_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the user that the wallet belongs to</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEvent</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L821">src/client/api.ts:821</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#address_index" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>index</span></a><a href="#seed_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>seed_<wbr/>id</span></a><a href="#signing_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signing_<wbr/>payload</span></a><a href="#transaction_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>id</span></a><a href="#transaction_type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>type</span></a><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a><a href="#wallet_user_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>user_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L821">src/client/api.ts:821</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#address_index" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>index</span></a><a href="#seed_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>seed_<wbr/>id</span></a><a href="#signing_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signing_<wbr/>payload</span></a><a href="#transaction_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>id</span></a><a href="#transaction_type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>type</span></a><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a><a href="#wallet_user_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>user_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.SignatureCreationEventResult.html b/docs/interfaces/client_api.SignatureCreationEventResult.html index 58056319..8dfdf3c9 100644 --- a/docs/interfaces/client_api.SignatureCreationEventResult.html +++ b/docs/interfaces/client_api.SignatureCreationEventResult.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SignatureCreationEventResult | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.SignatureCreationEventResult.html">SignatureCreationEventResult</a></li></ul><h1>Interface SignatureCreationEventResult</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The result to a SignatureCreationEvent.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>SignatureCreationEventResult</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SignatureCreationEventResult</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEventResult.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEventResult.html#signature">signature</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEventResult.html#transaction_id">transaction_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEventResult.html#transaction_type">transaction_type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"transfer"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEventResult.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEventResult.html#wallet_user_id">wallet_user_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L860">src/client/api.ts:860</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.SignatureCreationEventResult.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SignatureCreationEventResult</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEventResult.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEventResult.html#signature">signature</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEventResult.html#transaction_id">transaction_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEventResult.html#transaction_type">transaction_type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"transfer"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEventResult.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignatureCreationEventResult.html#wallet_user_id">wallet_user_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L860">src/client/api.ts:860</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.SignatureCreationEventResult.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> <a href="client_api.SignatureCreationEventResult.html#signature" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signature</span></a> <a href="client_api.SignatureCreationEventResult.html#transaction_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>id</span></a> <a href="client_api.SignatureCreationEventResult.html#transaction_type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>type</span></a> @@ -8,13 +8,13 @@ <a href="client_api.SignatureCreationEventResult.html#wallet_user_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>user_<wbr/>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="address_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>id</span><a href="#address_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the address the transfer belongs to</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEventResult</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L878">src/client/api.ts:878</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="signature" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>signature</span><a href="#signature" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signature</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The signature created by the server-signer.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L878">src/client/api.ts:878</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="signature" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>signature</span><a href="#signature" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signature</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The signature created by the server-signer.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEventResult</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L896">src/client/api.ts:896</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction_<wbr/>id</span><a href="#transaction_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the transaction that the Server-Signer has signed for</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L896">src/client/api.ts:896</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction_<wbr/>id</span><a href="#transaction_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the transaction that the Server-Signer has signed for</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEventResult</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L890">src/client/api.ts:890</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction_<wbr/>type</span><a href="#transaction_type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"transfer"</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEventResult</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L884">src/client/api.ts:884</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet that the event was created for.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L890">src/client/api.ts:890</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction_<wbr/>type</span><a href="#transaction_type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"transfer"</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEventResult</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L884">src/client/api.ts:884</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet that the event was created for.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEventResult</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L866">src/client/api.ts:866</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_user_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>user_<wbr/>id</span><a href="#wallet_user_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>user_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the user that the wallet belongs to</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L866">src/client/api.ts:866</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_user_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>user_<wbr/>id</span><a href="#wallet_user_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>user_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the user that the wallet belongs to</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignatureCreationEventResult</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L872">src/client/api.ts:872</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#signature" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signature</span></a><a href="#transaction_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>id</span></a><a href="#transaction_type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>type</span></a><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a><a href="#wallet_user_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>user_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L872">src/client/api.ts:872</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#signature" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signature</span></a><a href="#transaction_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>id</span></a><a href="#transaction_type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>type</span></a><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a><a href="#wallet_user_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>user_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.SignedVoluntaryExitMessageMetadata.html b/docs/interfaces/client_api.SignedVoluntaryExitMessageMetadata.html index c388ea11..739011d8 100644 --- a/docs/interfaces/client_api.SignedVoluntaryExitMessageMetadata.html +++ b/docs/interfaces/client_api.SignedVoluntaryExitMessageMetadata.html @@ -1,12 +1,12 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SignedVoluntaryExitMessageMetadata | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.SignedVoluntaryExitMessageMetadata.html">SignedVoluntaryExitMessageMetadata</a></li></ul><h1>Interface SignedVoluntaryExitMessageMetadata</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Signed voluntary exit message metadata to be provided to beacon chain to exit a validator.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>SignedVoluntaryExitMessageMetadata</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SignedVoluntaryExitMessageMetadata</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignedVoluntaryExitMessageMetadata.html#fork">fork</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignedVoluntaryExitMessageMetadata.html#signed_voluntary_exit">signed_voluntary_exit</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignedVoluntaryExitMessageMetadata.html#validator_pub_key">validator_pub_key</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L905">src/client/api.ts:905</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.SignedVoluntaryExitMessageMetadata.html#fork" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fork</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SignedVoluntaryExitMessageMetadata</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignedVoluntaryExitMessageMetadata.html#fork">fork</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignedVoluntaryExitMessageMetadata.html#signed_voluntary_exit">signed_voluntary_exit</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.SignedVoluntaryExitMessageMetadata.html#validator_pub_key">validator_pub_key</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L905">src/client/api.ts:905</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.SignedVoluntaryExitMessageMetadata.html#fork" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fork</span></a> <a href="client_api.SignedVoluntaryExitMessageMetadata.html#signed_voluntary_exit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>voluntary_<wbr/>exit</span></a> <a href="client_api.SignedVoluntaryExitMessageMetadata.html#validator_pub_key" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>validator_<wbr/>pub_<wbr/>key</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="fork" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fork</span><a href="#fork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fork</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The current fork version of the Ethereum beacon chain.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignedVoluntaryExitMessageMetadata</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L917">src/client/api.ts:917</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="signed_voluntary_exit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>signed_<wbr/>voluntary_<wbr/>exit</span><a href="#signed_voluntary_exit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signed_<wbr/>voluntary_<wbr/>exit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A base64 encoded version of a json string representing a voluntary exit message.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L917">src/client/api.ts:917</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="signed_voluntary_exit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>signed_<wbr/>voluntary_<wbr/>exit</span><a href="#signed_voluntary_exit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signed_<wbr/>voluntary_<wbr/>exit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A base64 encoded version of a json string representing a voluntary exit message.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignedVoluntaryExitMessageMetadata</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L923">src/client/api.ts:923</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="validator_pub_key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>validator_<wbr/>pub_<wbr/>key</span><a href="#validator_pub_key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">validator_<wbr/>pub_<wbr/>key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The public key of the validator associated with the exit message.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L923">src/client/api.ts:923</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="validator_pub_key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>validator_<wbr/>pub_<wbr/>key</span><a href="#validator_pub_key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">validator_<wbr/>pub_<wbr/>key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The public key of the validator associated with the exit message.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>SignedVoluntaryExitMessageMetadata</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L911">src/client/api.ts:911</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#fork" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fork</span></a><a href="#signed_voluntary_exit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>voluntary_<wbr/>exit</span></a><a href="#validator_pub_key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>validator_<wbr/>pub_<wbr/>key</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L911">src/client/api.ts:911</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#fork" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fork</span></a><a href="#signed_voluntary_exit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>voluntary_<wbr/>exit</span></a><a href="#validator_pub_key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>validator_<wbr/>pub_<wbr/>key</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.StakeApiInterface.html b/docs/interfaces/client_api.StakeApiInterface.html index 7acfa4a0..8a2581a4 100644 --- a/docs/interfaces/client_api.StakeApiInterface.html +++ b/docs/interfaces/client_api.StakeApiInterface.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakeApiInterface | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakeApiInterface.html">StakeApiInterface</a></li></ul><h1>Interface StakeApiInterface</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>StakeApi - interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>StakeApi</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">StakeApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.StakeApiInterface.html#buildStakingOperation.buildStakingOperation-1">buildStakingOperation</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.StakeApiInterface.html#fetchStakingRewards.fetchStakingRewards-1">fetchStakingRewards</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.StakeApiInterface.html#getExternalStakingOperation.getExternalStakingOperation-1">getExternalStakingOperation</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.StakeApiInterface.html#getStakingContext.getStakingContext-1">getStakingContext</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.StakeApi.html" class="tsd-signature-type tsd-kind-class">StakeApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3437">src/client/api.ts:3437</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.StakeApiInterface.html#buildStakingOperation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Staking<wbr/>Operation</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">StakeApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.StakeApiInterface.html#buildStakingOperation.buildStakingOperation-1">buildStakingOperation</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.StakeApiInterface.html#fetchStakingRewards.fetchStakingRewards-1">fetchStakingRewards</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.StakeApiInterface.html#getExternalStakingOperation.getExternalStakingOperation-1">getExternalStakingOperation</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.StakeApiInterface.html#getStakingContext.getStakingContext-1">getStakingContext</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.StakeApi.html" class="tsd-signature-type tsd-kind-class">StakeApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3437">src/client/api.ts:3437</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.StakeApiInterface.html#buildStakingOperation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Staking<wbr/>Operation</span></a> <a href="client_api.StakeApiInterface.html#fetchStakingRewards" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Staking<wbr/>Rewards</span></a> <a href="client_api.StakeApiInterface.html#getExternalStakingOperation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Staking<wbr/>Operation</span></a> <a href="client_api.StakeApiInterface.html#getStakingContext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Staking<wbr/>Context</span></a> @@ -8,21 +8,21 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>: <a href="client_api.BuildStakingOperationRequest.html" class="tsd-signature-type tsd-kind-interface">BuildStakingOperationRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Build a new staking operation</p> <h4>Throws</h4><h4>Memberof</h4><p>StakeApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3446">src/client/api.ts:3446</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fetchStakingRewards" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fetch<wbr/>Staking<wbr/>Rewards</span><a href="#fetchStakingRewards" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetchStakingRewards.fetchStakingRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><a href="#fetchStakingRewards.fetchStakingRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetch staking rewards for a list of addresses</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3446">src/client/api.ts:3446</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fetchStakingRewards" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fetch<wbr/>Staking<wbr/>Rewards</span><a href="#fetchStakingRewards" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetchStakingRewards.fetchStakingRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><a href="#fetchStakingRewards.fetchStakingRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetch staking rewards for a list of addresses</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>: <a href="client_api.FetchStakingRewardsRequest.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewardsRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Fetch staking rewards</p> <h4>Throws</h4><h4>Memberof</h4><p>StakeApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3458">src/client/api.ts:3458</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getExternalStakingOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>External<wbr/>Staking<wbr/>Operation</span><a href="#getExternalStakingOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getExternalStakingOperation.getExternalStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#getExternalStakingOperation.getExternalStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the latest state of a staking operation</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3458">src/client/api.ts:3458</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getExternalStakingOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>External<wbr/>Staking<wbr/>Operation</span><a href="#getExternalStakingOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getExternalStakingOperation.getExternalStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#getExternalStakingOperation.getExternalStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the latest state of a staking operation</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to fetch the staking operation for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">stakingOperationId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the staking operation</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the latest state of a staking operation</p> <h4>Throws</h4><h4>Memberof</h4><p>StakeApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3470">src/client/api.ts:3470</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStakingContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Staking<wbr/>Context</span><a href="#getStakingContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStakingContext.getStakingContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><a href="#getStakingContext.getStakingContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get staking context for an address</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3470">src/client/api.ts:3470</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStakingContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Staking<wbr/>Context</span><a href="#getStakingContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStakingContext.getStakingContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><a href="#getStakingContext.getStakingContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get staking context for an address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">getStakingContextRequest</span>: <a href="client_api.GetStakingContextRequest.html" class="tsd-signature-type tsd-kind-interface">GetStakingContextRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get staking context</p> <h4>Throws</h4><h4>Memberof</h4><p>StakeApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3480">src/client/api.ts:3480</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#buildStakingOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Staking<wbr/>Operation</span></a><a href="#fetchStakingRewards" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Staking<wbr/>Rewards</span></a><a href="#getExternalStakingOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Staking<wbr/>Operation</span></a><a href="#getStakingContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Staking<wbr/>Context</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3480">src/client/api.ts:3480</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#buildStakingOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build<wbr/>Staking<wbr/>Operation</span></a><a href="#fetchStakingRewards" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Staking<wbr/>Rewards</span></a><a href="#getExternalStakingOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>External<wbr/>Staking<wbr/>Operation</span></a><a href="#getStakingContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Staking<wbr/>Context</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.StakingContext.html b/docs/interfaces/client_api.StakingContext.html index 23ce922b..4786f391 100644 --- a/docs/interfaces/client_api.StakingContext.html +++ b/docs/interfaces/client_api.StakingContext.html @@ -1,5 +1,5 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingContext | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingContext.html">StakingContext</a></li></ul><h1>Interface StakingContext</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Context needed to perform a staking operation</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>StakingContext</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">StakingContext</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingContext.html#context">context</a><span class="tsd-signature-symbol">: </span><a href="../types/client_api.StakingContextContext.html" class="tsd-signature-type tsd-kind-type-alias">StakingContextContext</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L930">src/client/api.ts:930</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.StakingContext.html#context" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">StakingContext</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingContext.html#context">context</a><span class="tsd-signature-symbol">: </span><a href="../types/client_api.StakingContextContext.html" class="tsd-signature-type tsd-kind-type-alias">StakingContextContext</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L930">src/client/api.ts:930</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.StakingContext.html#context" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="context" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>context</span><a href="#context" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">context</span><span class="tsd-signature-symbol">:</span> <a href="../types/client_api.StakingContextContext.html" class="tsd-signature-type tsd-kind-type-alias">StakingContextContext</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingContext</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L936">src/client/api.ts:936</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#context" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L936">src/client/api.ts:936</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#context" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.StakingOperation.html b/docs/interfaces/client_api.StakingOperation.html index 92761ad5..70679e60 100644 --- a/docs/interfaces/client_api.StakingOperation.html +++ b/docs/interfaces/client_api.StakingOperation.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingOperation | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingOperation.html">StakingOperation</a></li></ul><h1>Interface StakingOperation</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A list of onchain transactions to help realize a staking action.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>StakingOperation</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">StakingOperation</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingOperation.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingOperation.html#id">id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingOperation.html#metadata">metadata</a><span class="tsd-signature-symbol">?: </span><a href="../types/client_api.StakingOperationMetadata.html" class="tsd-signature-type tsd-kind-type-alias">StakingOperationMetadata</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingOperation.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingOperation.html#status">status</a><span class="tsd-signature-symbol">: </span><a href="../types/client_api.StakingOperationStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">StakingOperationStatusEnum</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingOperation.html#transactions">transactions</a><span class="tsd-signature-symbol">: </span><a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L949">src/client/api.ts:949</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.StakingOperation.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">StakingOperation</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingOperation.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingOperation.html#id">id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingOperation.html#metadata">metadata</a><span class="tsd-signature-symbol">?: </span><a href="../types/client_api.StakingOperationMetadata.html" class="tsd-signature-type tsd-kind-type-alias">StakingOperationMetadata</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingOperation.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingOperation.html#status">status</a><span class="tsd-signature-symbol">: </span><a href="../types/client_api.StakingOperationStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">StakingOperationStatusEnum</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingOperation.html#transactions">transactions</a><span class="tsd-signature-symbol">: </span><a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L949">src/client/api.ts:949</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.StakingOperation.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> <a href="client_api.StakingOperation.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a> <a href="client_api.StakingOperation.html#metadata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>metadata?</span></a> <a href="client_api.StakingOperation.html#network_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a> @@ -8,13 +8,13 @@ <a href="client_api.StakingOperation.html#transactions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transactions</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="address_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>id</span><a href="#address_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The onchain address orchestrating the staking operation.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingOperation</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L967">src/client/api.ts:967</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The unique ID of the staking operation.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L967">src/client/api.ts:967</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The unique ID of the staking operation.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingOperation</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L955">src/client/api.ts:955</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="metadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>metadata</span><a href="#metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">metadata</span><span class="tsd-signature-symbol">?:</span> <a href="../types/client_api.StakingOperationMetadata.html" class="tsd-signature-type tsd-kind-type-alias">StakingOperationMetadata</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingOperation</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L985">src/client/api.ts:985</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L955">src/client/api.ts:955</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="metadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>metadata</span><a href="#metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">metadata</span><span class="tsd-signature-symbol">?:</span> <a href="../types/client_api.StakingOperationMetadata.html" class="tsd-signature-type tsd-kind-type-alias">StakingOperationMetadata</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingOperation</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L985">src/client/api.ts:985</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingOperation</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L961">src/client/api.ts:961</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <a href="../types/client_api.StakingOperationStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">StakingOperationStatusEnum</a></div><div class="tsd-comment tsd-typography"><p>The status of the staking operation</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L961">src/client/api.ts:961</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <a href="../types/client_api.StakingOperationStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">StakingOperationStatusEnum</a></div><div class="tsd-comment tsd-typography"><p>The status of the staking operation</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingOperation</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L973">src/client/api.ts:973</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transactions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transactions</span><a href="#transactions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transactions</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The transaction(s) that will execute the staking operation onchain</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L973">src/client/api.ts:973</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transactions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transactions</span><a href="#transactions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transactions</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The transaction(s) that will execute the staking operation onchain</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingOperation</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L979">src/client/api.ts:979</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#metadata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>metadata</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#transactions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transactions</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L979">src/client/api.ts:979</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#metadata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>metadata</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#transactions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transactions</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.StakingReward.html b/docs/interfaces/client_api.StakingReward.html index e49c6a4d..41965041 100644 --- a/docs/interfaces/client_api.StakingReward.html +++ b/docs/interfaces/client_api.StakingReward.html @@ -1,17 +1,17 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingReward | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingReward.html">StakingReward</a></li></ul><h1>Interface StakingReward</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The staking rewards for an address.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>StakingReward</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">StakingReward</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingReward.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingReward.html#amount">amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingReward.html#date">date</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingReward.html#format">format</a><span class="tsd-signature-symbol">: </span><a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingReward.html#state">state</a><span class="tsd-signature-symbol">: </span><a href="../types/client_api.StakingRewardStateEnum.html" class="tsd-signature-type tsd-kind-type-alias">StakingRewardStateEnum</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1008">src/client/api.ts:1008</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.StakingReward.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">StakingReward</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingReward.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingReward.html#amount">amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingReward.html#date">date</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingReward.html#format">format</a><span class="tsd-signature-symbol">: </span><a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.StakingReward.html#state">state</a><span class="tsd-signature-symbol">: </span><a href="../types/client_api.StakingRewardStateEnum.html" class="tsd-signature-type tsd-kind-type-alias">StakingRewardStateEnum</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1008">src/client/api.ts:1008</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.StakingReward.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> <a href="client_api.StakingReward.html#amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a> <a href="client_api.StakingReward.html#date" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>date</span></a> <a href="client_api.StakingReward.html#format" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>format</span></a> <a href="client_api.StakingReward.html#state" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="address_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>id</span><a href="#address_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The onchain address for which the staking rewards are being fetched.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingReward</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1014">src/client/api.ts:1014</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>amount</span><a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The reward amount in requested "format". Default is USD.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1014">src/client/api.ts:1014</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>amount</span><a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The reward amount in requested "format". Default is USD.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingReward</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1026">src/client/api.ts:1026</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="date" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>date</span><a href="#date" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">date</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The date of the reward in format 'YYYY-MM-DD' in UTC.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1026">src/client/api.ts:1026</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="date" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>date</span><a href="#date" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">date</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The date of the reward in format 'YYYY-MM-DD' in UTC.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingReward</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1020">src/client/api.ts:1020</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="format" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>format</span><a href="#format" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingReward</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1038">src/client/api.ts:1038</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="state" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <a href="../types/client_api.StakingRewardStateEnum.html" class="tsd-signature-type tsd-kind-type-alias">StakingRewardStateEnum</a></div><div class="tsd-comment tsd-typography"><p>The state of the reward.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1020">src/client/api.ts:1020</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="format" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>format</span><a href="#format" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">format</span><span class="tsd-signature-symbol">:</span> <a href="../enums/client_api.StakingRewardFormat.html" class="tsd-signature-type tsd-kind-enum">StakingRewardFormat</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingReward</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1038">src/client/api.ts:1038</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="state" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <a href="../types/client_api.StakingRewardStateEnum.html" class="tsd-signature-type tsd-kind-type-alias">StakingRewardStateEnum</a></div><div class="tsd-comment tsd-typography"><p>The state of the reward.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>StakingReward</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1032">src/client/api.ts:1032</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#date" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>date</span></a><a href="#format" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>format</span></a><a href="#state" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1032">src/client/api.ts:1032</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#date" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>date</span></a><a href="#format" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>format</span></a><a href="#state" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.Trade.html b/docs/interfaces/client_api.Trade.html index ef5941ad..35c168ec 100644 --- a/docs/interfaces/client_api.Trade.html +++ b/docs/interfaces/client_api.Trade.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Trade | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.Trade.html">Trade</a></li></ul><h1>Interface Trade</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A trade of an asset to another asset</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>Trade</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Trade</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#approve_transaction">approve_transaction</a><span class="tsd-signature-symbol">?: </span><a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#from_amount">from_amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#from_asset">from_asset</a><span class="tsd-signature-symbol">: </span><a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#to_amount">to_amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#to_asset">to_asset</a><span class="tsd-signature-symbol">: </span><a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#trade_id">trade_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#transaction">transaction</a><span class="tsd-signature-symbol">: </span><a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1067">src/client/api.ts:1067</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Trade.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Trade</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#approve_transaction">approve_transaction</a><span class="tsd-signature-symbol">?: </span><a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#from_amount">from_amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#from_asset">from_asset</a><span class="tsd-signature-symbol">: </span><a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#to_amount">to_amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#to_asset">to_asset</a><span class="tsd-signature-symbol">: </span><a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#trade_id">trade_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#transaction">transaction</a><span class="tsd-signature-symbol">: </span><a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Trade.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1067">src/client/api.ts:1067</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Trade.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> <a href="client_api.Trade.html#approve_transaction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>approve_<wbr/>transaction?</span></a> <a href="client_api.Trade.html#from_amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>amount</span></a> <a href="client_api.Trade.html#from_asset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>asset</span></a> @@ -12,18 +12,18 @@ <a href="client_api.Trade.html#wallet_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="address_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>id</span><a href="#address_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The onchain address of the sender</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1085">src/client/api.ts:1085</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="approve_transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>approve_<wbr/>transaction</span><a href="#approve_transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">approve_<wbr/>transaction</span><span class="tsd-signature-symbol">?:</span> <a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1127">src/client/api.ts:1127</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="from_amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from_<wbr/>amount</span><a href="#from_amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">from_<wbr/>amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The amount of the from asset to be traded (in atomic units of the from asset)</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1085">src/client/api.ts:1085</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="approve_transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>approve_<wbr/>transaction</span><a href="#approve_transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">approve_<wbr/>transaction</span><span class="tsd-signature-symbol">?:</span> <a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1127">src/client/api.ts:1127</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="from_amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from_<wbr/>amount</span><a href="#from_amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">from_<wbr/>amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The amount of the from asset to be traded (in atomic units of the from asset)</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1097">src/client/api.ts:1097</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="from_asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from_<wbr/>asset</span><a href="#from_asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">from_<wbr/>asset</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1103">src/client/api.ts:1103</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1097">src/client/api.ts:1097</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="from_asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from_<wbr/>asset</span><a href="#from_asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">from_<wbr/>asset</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1103">src/client/api.ts:1103</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1073">src/client/api.ts:1073</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="to_amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to_<wbr/>amount</span><a href="#to_amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">to_<wbr/>amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The amount of the to asset that will be received (in atomic units of the to asset)</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1073">src/client/api.ts:1073</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="to_amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to_<wbr/>amount</span><a href="#to_amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">to_<wbr/>amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The amount of the to asset that will be received (in atomic units of the to asset)</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1109">src/client/api.ts:1109</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="to_asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to_<wbr/>asset</span><a href="#to_asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">to_<wbr/>asset</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1115">src/client/api.ts:1115</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="trade_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>trade_<wbr/>id</span><a href="#trade_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">trade_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the trade</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1109">src/client/api.ts:1109</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="to_asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to_<wbr/>asset</span><a href="#to_asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">to_<wbr/>asset</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1115">src/client/api.ts:1115</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="trade_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>trade_<wbr/>id</span><a href="#trade_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">trade_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the trade</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1091">src/client/api.ts:1091</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction</span><a href="#transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1121">src/client/api.ts:1121</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet that owns the from address</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1091">src/client/api.ts:1091</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction</span><a href="#transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1121">src/client/api.ts:1121</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet that owns the from address</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Trade</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1079">src/client/api.ts:1079</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#approve_transaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>approve_<wbr/>transaction</span></a><a href="#from_amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>amount</span></a><a href="#from_asset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>asset</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#to_amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to_<wbr/>amount</span></a><a href="#to_asset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to_<wbr/>asset</span></a><a href="#trade_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>trade_<wbr/>id</span></a><a href="#transaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction</span></a><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1079">src/client/api.ts:1079</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#approve_transaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>approve_<wbr/>transaction</span></a><a href="#from_amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>amount</span></a><a href="#from_asset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>asset</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#to_amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to_<wbr/>amount</span></a><a href="#to_asset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to_<wbr/>asset</span></a><a href="#trade_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>trade_<wbr/>id</span></a><a href="#transaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction</span></a><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.TradeList.html b/docs/interfaces/client_api.TradeList.html index c5b45867..abc4fe17 100644 --- a/docs/interfaces/client_api.TradeList.html +++ b/docs/interfaces/client_api.TradeList.html @@ -1,13 +1,13 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TradeList | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TradeList.html">TradeList</a></li></ul><h1>Interface TradeList</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>TradeList</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">TradeList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TradeList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TradeList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TradeList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TradeList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1134">src/client/api.ts:1134</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.TradeList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">TradeList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TradeList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TradeList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TradeList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TradeList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1134">src/client/api.ts:1134</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.TradeList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> <a href="client_api.TradeList.html#has_more" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a> <a href="client_api.TradeList.html#next_page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a> <a href="client_api.TradeList.html#total_count" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>TradeList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1140">src/client/api.ts:1140</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1140">src/client/api.ts:1140</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>TradeList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1146">src/client/api.ts:1146</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1146">src/client/api.ts:1146</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>TradeList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1152">src/client/api.ts:1152</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of trades for the address in the wallet.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1152">src/client/api.ts:1152</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of trades for the address in the wallet.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>TradeList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1158">src/client/api.ts:1158</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1158">src/client/api.ts:1158</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.TradesApiInterface.html b/docs/interfaces/client_api.TradesApiInterface.html index a084f2e8..81a4e9d8 100644 --- a/docs/interfaces/client_api.TradesApiInterface.html +++ b/docs/interfaces/client_api.TradesApiInterface.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TradesApiInterface | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TradesApiInterface.html">TradesApiInterface</a></li></ul><h1>Interface TradesApiInterface</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>TradesApi - interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>TradesApi</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">TradesApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TradesApiInterface.html#broadcastTrade.broadcastTrade-1">broadcastTrade</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">broadcastTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TradesApiInterface.html#createTrade.createTrade-1">createTrade</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TradesApiInterface.html#getTrade.getTrade-1">getTrade</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TradesApiInterface.html#listTrades.listTrades-1">listTrades</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.TradesApi.html" class="tsd-signature-type tsd-kind-class">TradesApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3874">src/client/api.ts:3874</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.TradesApiInterface.html#broadcastTrade" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Trade</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">TradesApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TradesApiInterface.html#broadcastTrade.broadcastTrade-1">broadcastTrade</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">broadcastTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TradesApiInterface.html#createTrade.createTrade-1">createTrade</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TradesApiInterface.html#getTrade.getTrade-1">getTrade</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TradesApiInterface.html#listTrades.listTrades-1">listTrades</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.TradesApi.html" class="tsd-signature-type tsd-kind-class">TradesApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3874">src/client/api.ts:3874</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.TradesApiInterface.html#broadcastTrade" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Trade</span></a> <a href="client_api.TradesApiInterface.html#createTrade" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Trade</span></a> <a href="client_api.TradesApiInterface.html#getTrade" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trade</span></a> <a href="client_api.TradesApiInterface.html#listTrades" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Trades</span></a> @@ -11,20 +11,20 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">broadcastTradeRequest</span>: <a href="client_api.BroadcastTradeRequest.html" class="tsd-signature-type tsd-kind-interface">BroadcastTradeRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Broadcast a trade</p> <h4>Throws</h4><h4>Memberof</h4><p>TradesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3886">src/client/api.ts:3886</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Trade</span><a href="#createTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><a href="#createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new trade</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3886">src/client/api.ts:3886</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Trade</span><a href="#createTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><a href="#createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new trade</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the source address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to conduct the trade from</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">createTradeRequest</span>: <a href="client_api.CreateTradeRequest.html" class="tsd-signature-type tsd-kind-interface">CreateTradeRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new trade for an address</p> <h4>Throws</h4><h4>Memberof</h4><p>TradesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3898">src/client/api.ts:3898</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Trade</span><a href="#getTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTrade.getTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><a href="#getTrade.getTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a trade by ID</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3898">src/client/api.ts:3898</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTrade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Trade</span><a href="#getTrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTrade.getTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><a href="#getTrade.getTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a trade by ID</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the trade belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">tradeId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the trade to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a trade by ID</p> <h4>Throws</h4><h4>Memberof</h4><p>TradesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3910">src/client/api.ts:3910</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTrades" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Trades</span><a href="#listTrades" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTrades.listTrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Trades</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span><a href="#listTrades.listTrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List trades for an address.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3910">src/client/api.ts:3910</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTrades" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Trades</span><a href="#listTrades" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTrades.listTrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Trades</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span><a href="#listTrades.listTrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List trades for an address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to list trades for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> @@ -32,4 +32,4 @@ <h4>Throws</h4><h4>Memberof</h4><p>TradesApiInterface</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List trades for an address.</p> <h4>Throws</h4><h4>Memberof</h4><p>TradesApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L3923">src/client/api.ts:3923</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#broadcastTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Trade</span></a><a href="#createTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Trade</span></a><a href="#getTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trade</span></a><a href="#listTrades" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Trades</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L3923">src/client/api.ts:3923</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#broadcastTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Trade</span></a><a href="#createTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Trade</span></a><a href="#getTrade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trade</span></a><a href="#listTrades" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Trades</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.Transaction.html b/docs/interfaces/client_api.Transaction.html index 374b1075..815afcac 100644 --- a/docs/interfaces/client_api.Transaction.html +++ b/docs/interfaces/client_api.Transaction.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Transaction | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.Transaction.html">Transaction</a></li></ul><h1>Interface Transaction</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An onchain transaction.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>Transaction</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Transaction</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#from_address_id">from_address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#signed_payload">signed_payload</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#status">status</a><span class="tsd-signature-symbol">: </span><a href="../types/client_api.TransactionStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">TransactionStatusEnum</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#transaction_hash">transaction_hash</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#transaction_link">transaction_link</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#unsigned_payload">unsigned_payload</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1165">src/client/api.ts:1165</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Transaction.html#from_address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>address_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Transaction</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#from_address_id">from_address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#signed_payload">signed_payload</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#status">status</a><span class="tsd-signature-symbol">: </span><a href="../types/client_api.TransactionStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">TransactionStatusEnum</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#transaction_hash">transaction_hash</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#transaction_link">transaction_link</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transaction.html#unsigned_payload">unsigned_payload</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1165">src/client/api.ts:1165</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Transaction.html#from_address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>address_<wbr/>id</span></a> <a href="client_api.Transaction.html#network_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a> <a href="client_api.Transaction.html#signed_payload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>payload?</span></a> <a href="client_api.Transaction.html#status" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a> @@ -9,16 +9,16 @@ <a href="client_api.Transaction.html#unsigned_payload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsigned_<wbr/>payload</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="from_address_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from_<wbr/>address_<wbr/>id</span><a href="#from_address_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">from_<wbr/>address_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The onchain address of the sender</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transaction</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1177">src/client/api.ts:1177</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1177">src/client/api.ts:1177</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transaction</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1171">src/client/api.ts:1171</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="signed_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>signed_<wbr/>payload</span><a href="#signed_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signed_<wbr/>payload</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The signed payload of the transaction. This is the payload that has been signed by the sender.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1171">src/client/api.ts:1171</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="signed_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>signed_<wbr/>payload</span><a href="#signed_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signed_<wbr/>payload</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The signed payload of the transaction. This is the payload that has been signed by the sender.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transaction</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1189">src/client/api.ts:1189</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <a href="../types/client_api.TransactionStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">TransactionStatusEnum</a></div><div class="tsd-comment tsd-typography"><p>The status of the transaction</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1189">src/client/api.ts:1189</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <a href="../types/client_api.TransactionStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">TransactionStatusEnum</a></div><div class="tsd-comment tsd-typography"><p>The status of the transaction</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transaction</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1207">src/client/api.ts:1207</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>transaction_<wbr/>hash</span><a href="#transaction_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>hash</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The hash of the transaction</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1207">src/client/api.ts:1207</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>transaction_<wbr/>hash</span><a href="#transaction_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>hash</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The hash of the transaction</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transaction</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1195">src/client/api.ts:1195</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_link" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>transaction_<wbr/>link</span><a href="#transaction_link" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>link</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The link to view the transaction on a block explorer. This is optional and may not be present for all transactions.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1195">src/client/api.ts:1195</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_link" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>transaction_<wbr/>link</span><a href="#transaction_link" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>link</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The link to view the transaction on a block explorer. This is optional and may not be present for all transactions.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transaction</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1201">src/client/api.ts:1201</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unsigned_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsigned_<wbr/>payload</span><a href="#unsigned_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unsigned_<wbr/>payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1201">src/client/api.ts:1201</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unsigned_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsigned_<wbr/>payload</span><a href="#unsigned_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unsigned_<wbr/>payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transaction</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1183">src/client/api.ts:1183</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#from_address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>address_<wbr/>id</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#signed_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>payload</span></a><a href="#status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#transaction_hash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>hash</span></a><a href="#transaction_link" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>link</span></a><a href="#unsigned_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsigned_<wbr/>payload</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1183">src/client/api.ts:1183</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#from_address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from_<wbr/>address_<wbr/>id</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#signed_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>payload</span></a><a href="#status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#transaction_hash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>hash</span></a><a href="#transaction_link" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>link</span></a><a href="#unsigned_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsigned_<wbr/>payload</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.Transfer.html b/docs/interfaces/client_api.Transfer.html index 512555df..3d5607e0 100644 --- a/docs/interfaces/client_api.Transfer.html +++ b/docs/interfaces/client_api.Transfer.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Transfer | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.Transfer.html">Transfer</a></li></ul><h1>Interface Transfer</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A transfer of an asset from one address to another</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>Transfer</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Transfer</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#amount">amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#asset">asset</a><span class="tsd-signature-symbol">: </span><a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#destination">destination</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#signed_payload">signed_payload</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#status">status</a><span class="tsd-signature-symbol">: </span><a href="../types/client_api.TransferStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">TransferStatusEnum</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#transaction">transaction</a><span class="tsd-signature-symbol">: </span><a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#transaction_hash">transaction_hash</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#transfer_id">transfer_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#unsigned_payload">unsigned_payload</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1238">src/client/api.ts:1238</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Transfer.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Transfer</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#address_id">address_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#amount">amount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#asset">asset</a><span class="tsd-signature-symbol">: </span><a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#destination">destination</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#signed_payload">signed_payload</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#status">status</a><span class="tsd-signature-symbol">: </span><a href="../types/client_api.TransferStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">TransferStatusEnum</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#transaction">transaction</a><span class="tsd-signature-symbol">: </span><a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#transaction_hash">transaction_hash</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#transfer_id">transfer_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#unsigned_payload">unsigned_payload</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Transfer.html#wallet_id">wallet_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1238">src/client/api.ts:1238</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Transfer.html#address_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a> <a href="client_api.Transfer.html#amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a> <a href="client_api.Transfer.html#asset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset</span></a> <a href="client_api.Transfer.html#asset_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a> @@ -15,26 +15,26 @@ <a href="client_api.Transfer.html#wallet_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="address_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address_<wbr/>id</span><a href="#address_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">address_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The onchain address of the sender</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1256">src/client/api.ts:1256</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>amount</span><a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The amount in the atomic units of the asset</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1256">src/client/api.ts:1256</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>amount</span><a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The amount in the atomic units of the asset</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1268">src/client/api.ts:1268</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset</span><a href="#asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1280">src/client/api.ts:1280</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset_<wbr/>id</span><a href="#asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset being transferred</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1268">src/client/api.ts:1268</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset</span><a href="#asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1280">src/client/api.ts:1280</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset_<wbr/>id</span><a href="#asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset being transferred</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1274">src/client/api.ts:1274</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="destination" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destination</span><a href="#destination" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">destination</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The onchain address of the recipient</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1274">src/client/api.ts:1274</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="destination" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destination</span><a href="#destination" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">destination</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The onchain address of the recipient</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1262">src/client/api.ts:1262</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1262">src/client/api.ts:1262</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1244">src/client/api.ts:1244</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="signed_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>signed_<wbr/>payload</span><a href="#signed_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signed_<wbr/>payload</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The signed payload of the transfer. This is the payload that has been signed by the sender.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1244">src/client/api.ts:1244</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="signed_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>signed_<wbr/>payload</span><a href="#signed_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signed_<wbr/>payload</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The signed payload of the transfer. This is the payload that has been signed by the sender.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1304">src/client/api.ts:1304</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <a href="../types/client_api.TransferStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">TransferStatusEnum</a></div><div class="tsd-comment tsd-typography"><p>The status of the transfer</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1304">src/client/api.ts:1304</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <a href="../types/client_api.TransferStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">TransferStatusEnum</a></div><div class="tsd-comment tsd-typography"><p>The status of the transfer</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1316">src/client/api.ts:1316</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction</span><a href="#transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1292">src/client/api.ts:1292</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>transaction_<wbr/>hash</span><a href="#transaction_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>hash</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The hash of the transfer transaction</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1316">src/client/api.ts:1316</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transaction</span><a href="#transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Transaction.html" class="tsd-signature-type tsd-kind-interface">Transaction</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1292">src/client/api.ts:1292</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transaction_hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>transaction_<wbr/>hash</span><a href="#transaction_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transaction_<wbr/>hash</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The hash of the transfer transaction</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1310">src/client/api.ts:1310</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transfer_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transfer_<wbr/>id</span><a href="#transfer_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transfer_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the transfer</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1310">src/client/api.ts:1310</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transfer_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transfer_<wbr/>id</span><a href="#transfer_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transfer_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the transfer</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1286">src/client/api.ts:1286</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unsigned_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsigned_<wbr/>payload</span><a href="#unsigned_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unsigned_<wbr/>payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The unsigned payload of the transfer. This is the payload that needs to be signed by the sender.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1286">src/client/api.ts:1286</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unsigned_payload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsigned_<wbr/>payload</span><a href="#unsigned_payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unsigned_<wbr/>payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The unsigned payload of the transfer. This is the payload that needs to be signed by the sender.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1298">src/client/api.ts:1298</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet that owns the from address</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1298">src/client/api.ts:1298</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wallet_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wallet_<wbr/>id</span><a href="#wallet_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wallet_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the wallet that owns the from address</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Transfer</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1250">src/client/api.ts:1250</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#asset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset</span></a><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#destination" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>destination</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#signed_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>payload</span></a><a href="#status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#transaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction</span></a><a href="#transaction_hash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>hash</span></a><a href="#transfer_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transfer_<wbr/>id</span></a><a href="#unsigned_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsigned_<wbr/>payload</span></a><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1250">src/client/api.ts:1250</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#address_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address_<wbr/>id</span></a><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#asset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset</span></a><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#destination" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>destination</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#signed_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signed_<wbr/>payload</span></a><a href="#status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#transaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction</span></a><a href="#transaction_hash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transaction_<wbr/>hash</span></a><a href="#transfer_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transfer_<wbr/>id</span></a><a href="#unsigned_payload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsigned_<wbr/>payload</span></a><a href="#wallet_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wallet_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.TransferList.html b/docs/interfaces/client_api.TransferList.html index c53b38e9..a3ec1530 100644 --- a/docs/interfaces/client_api.TransferList.html +++ b/docs/interfaces/client_api.TransferList.html @@ -1,13 +1,13 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransferList | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransferList.html">TransferList</a></li></ul><h1>Interface TransferList</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>TransferList</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">TransferList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TransferList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TransferList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TransferList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TransferList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1333">src/client/api.ts:1333</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.TransferList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">TransferList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TransferList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TransferList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TransferList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.TransferList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1333">src/client/api.ts:1333</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.TransferList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> <a href="client_api.TransferList.html#has_more" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a> <a href="client_api.TransferList.html#next_page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a> <a href="client_api.TransferList.html#total_count" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>TransferList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1339">src/client/api.ts:1339</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1339">src/client/api.ts:1339</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>TransferList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1345">src/client/api.ts:1345</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1345">src/client/api.ts:1345</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>TransferList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1351">src/client/api.ts:1351</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of transfers for the address in the wallet.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1351">src/client/api.ts:1351</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of transfers for the address in the wallet.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>TransferList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1357">src/client/api.ts:1357</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1357">src/client/api.ts:1357</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.TransfersApiInterface.html b/docs/interfaces/client_api.TransfersApiInterface.html index 1d62653f..213a1be4 100644 --- a/docs/interfaces/client_api.TransfersApiInterface.html +++ b/docs/interfaces/client_api.TransfersApiInterface.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransfersApiInterface | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransfersApiInterface.html">TransfersApiInterface</a></li></ul><h1>Interface TransfersApiInterface</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>TransfersApi - interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>TransfersApi</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">TransfersApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TransfersApiInterface.html#broadcastTransfer.broadcastTransfer-1">broadcastTransfer</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">broadcastTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TransfersApiInterface.html#createTransfer.createTransfer-1">createTransfer</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TransfersApiInterface.html#getTransfer.getTransfer-1">getTransfer</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TransfersApiInterface.html#listTransfers.listTransfers-1">listTransfers</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.TransfersApi.html" class="tsd-signature-type tsd-kind-class">TransfersApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4323">src/client/api.ts:4323</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.TransfersApiInterface.html#broadcastTransfer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Transfer</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">TransfersApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TransfersApiInterface.html#broadcastTransfer.broadcastTransfer-1">broadcastTransfer</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">broadcastTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TransfersApiInterface.html#createTransfer.createTransfer-1">createTransfer</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TransfersApiInterface.html#getTransfer.getTransfer-1">getTransfer</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.TransfersApiInterface.html#listTransfers.listTransfers-1">listTransfers</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.TransfersApi.html" class="tsd-signature-type tsd-kind-class">TransfersApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4323">src/client/api.ts:4323</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.TransfersApiInterface.html#broadcastTransfer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Transfer</span></a> <a href="client_api.TransfersApiInterface.html#createTransfer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Transfer</span></a> <a href="client_api.TransfersApiInterface.html#getTransfer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transfer</span></a> <a href="client_api.TransfersApiInterface.html#listTransfers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Transfers</span></a> @@ -11,20 +11,20 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">broadcastTransferRequest</span>: <a href="client_api.BroadcastTransferRequest.html" class="tsd-signature-type tsd-kind-interface">BroadcastTransferRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Broadcast a transfer</p> <h4>Throws</h4><h4>Memberof</h4><p>TransfersApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4335">src/client/api.ts:4335</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Transfer</span><a href="#createTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><a href="#createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new transfer</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4335">src/client/api.ts:4335</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Transfer</span><a href="#createTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><a href="#createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new transfer</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the source address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to transfer from</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">createTransferRequest</span>: <a href="client_api.CreateTransferRequest.html" class="tsd-signature-type tsd-kind-interface">CreateTransferRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new transfer for an address</p> <h4>Throws</h4><h4>Memberof</h4><p>TransfersApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4347">src/client/api.ts:4347</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transfer</span><a href="#getTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransfer.getTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><a href="#getTransfer.getTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a transfer by ID</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4347">src/client/api.ts:4347</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Transfer</span><a href="#getTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTransfer.getTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><a href="#getTransfer.getTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a transfer by ID</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the transfer belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">transferId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the transfer to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a transfer by ID</p> <h4>Throws</h4><h4>Memberof</h4><p>TransfersApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4359">src/client/api.ts:4359</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTransfers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Transfers</span><a href="#listTransfers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTransfers.listTransfers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Transfers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span><a href="#listTransfers.listTransfers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List transfers for an address.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4359">src/client/api.ts:4359</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTransfers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Transfers</span><a href="#listTransfers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTransfers.listTransfers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Transfers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span><a href="#listTransfers.listTransfers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List transfers for an address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to list transfers for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> @@ -32,4 +32,4 @@ <h4>Throws</h4><h4>Memberof</h4><p>TransfersApiInterface</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List transfers for an address.</p> <h4>Throws</h4><h4>Memberof</h4><p>TransfersApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4372">src/client/api.ts:4372</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#broadcastTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Transfer</span></a><a href="#createTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Transfer</span></a><a href="#getTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transfer</span></a><a href="#listTransfers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Transfers</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4372">src/client/api.ts:4372</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#broadcastTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>broadcast<wbr/>Transfer</span></a><a href="#createTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Transfer</span></a><a href="#getTransfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Transfer</span></a><a href="#listTransfers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Transfers</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.User.html b/docs/interfaces/client_api.User.html index 13844c17..7a571299 100644 --- a/docs/interfaces/client_api.User.html +++ b/docs/interfaces/client_api.User.html @@ -1,7 +1,7 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>User | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.User.html">User</a></li></ul><h1>Interface User</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>User</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">User</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.User.html#display_name">display_name</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.User.html#id">id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1364">src/client/api.ts:1364</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.User.html#display_name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display_<wbr/>name?</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">User</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.User.html#display_name">display_name</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.User.html#id">id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1364">src/client/api.ts:1364</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.User.html#display_name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display_<wbr/>name?</span></a> <a href="client_api.User.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="display_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>display_<wbr/>name</span><a href="#display_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">display_<wbr/>name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>User</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1376">src/client/api.ts:1376</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the user</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1376">src/client/api.ts:1376</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the user</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>User</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1370">src/client/api.ts:1370</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#display_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display_<wbr/>name</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1370">src/client/api.ts:1370</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#display_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display_<wbr/>name</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.UsersApiInterface.html b/docs/interfaces/client_api.UsersApiInterface.html index 638034cb..8979df8e 100644 --- a/docs/interfaces/client_api.UsersApiInterface.html +++ b/docs/interfaces/client_api.UsersApiInterface.html @@ -1,8 +1,8 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UsersApiInterface | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.UsersApiInterface.html">UsersApiInterface</a></li></ul><h1>Interface UsersApiInterface</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>UsersApi - interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>UsersApi</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">UsersApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.UsersApiInterface.html#getCurrentUser.getCurrentUser-1">getCurrentUser</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.UsersApi.html" class="tsd-signature-type tsd-kind-class">UsersApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4529">src/client/api.ts:4529</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.UsersApiInterface.html#getCurrentUser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>User</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">UsersApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.UsersApiInterface.html#getCurrentUser.getCurrentUser-1">getCurrentUser</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.UsersApi.html" class="tsd-signature-type tsd-kind-class">UsersApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4529">src/client/api.ts:4529</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.UsersApiInterface.html#getCurrentUser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>User</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getCurrentUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Current<wbr/>User</span><a href="#getCurrentUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getCurrentUser.getCurrentUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Current<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">></span><a href="#getCurrentUser.getCurrentUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get current user</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.User.html" class="tsd-signature-type tsd-kind-interface">User</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get current user</p> <h4>Throws</h4><h4>Memberof</h4><p>UsersApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4537">src/client/api.ts:4537</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#getCurrentUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>User</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4537">src/client/api.ts:4537</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#getCurrentUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>User</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.Validator.html b/docs/interfaces/client_api.Validator.html index c901a776..2da02432 100644 --- a/docs/interfaces/client_api.Validator.html +++ b/docs/interfaces/client_api.Validator.html @@ -1,17 +1,17 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Validator | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.Validator.html">Validator</a></li></ul><h1>Interface Validator</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A validator onchain.</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>Validator</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Validator</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Validator.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Validator.html#details">details</a><span class="tsd-signature-symbol">?: </span><a href="client_api.EthereumValidatorMetadata.html" class="tsd-signature-type tsd-kind-interface">EthereumValidatorMetadata</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Validator.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Validator.html#status">status</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Validator.html#validator_id">validator_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1383">src/client/api.ts:1383</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Validator.html#asset_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Validator</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Validator.html#asset_id">asset_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Validator.html#details">details</a><span class="tsd-signature-symbol">?: </span><a href="client_api.EthereumValidatorMetadata.html" class="tsd-signature-type tsd-kind-interface">EthereumValidatorMetadata</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Validator.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Validator.html#status">status</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Validator.html#validator_id">validator_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1383">src/client/api.ts:1383</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Validator.html#asset_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a> <a href="client_api.Validator.html#details" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>details?</span></a> <a href="client_api.Validator.html#network_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a> <a href="client_api.Validator.html#status" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a> <a href="client_api.Validator.html#validator_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>validator_<wbr/>id</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="asset_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset_<wbr/>id</span><a href="#asset_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asset_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the asset that the validator helps stake.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Validator</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1401">src/client/api.ts:1401</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="details" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>details</span><a href="#details" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">details</span><span class="tsd-signature-symbol">?:</span> <a href="client_api.EthereumValidatorMetadata.html" class="tsd-signature-type tsd-kind-interface">EthereumValidatorMetadata</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Validator</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1413">src/client/api.ts:1413</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network to which the Validator belongs.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1401">src/client/api.ts:1401</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="details" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>details</span><a href="#details" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">details</span><span class="tsd-signature-symbol">?:</span> <a href="client_api.EthereumValidatorMetadata.html" class="tsd-signature-type tsd-kind-interface">EthereumValidatorMetadata</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Validator</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1413">src/client/api.ts:1413</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network to which the Validator belongs.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Validator</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1395">src/client/api.ts:1395</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The status of the validator.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1395">src/client/api.ts:1395</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The status of the validator.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Validator</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1407">src/client/api.ts:1407</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="validator_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>validator_<wbr/>id</span><a href="#validator_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">validator_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The publicly identifiable unique id of the validator. This can be the public key for Ethereum validators and maybe an address for some other network.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1407">src/client/api.ts:1407</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="validator_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>validator_<wbr/>id</span><a href="#validator_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">validator_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The publicly identifiable unique id of the validator. This can be the public key for Ethereum validators and maybe an address for some other network.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Validator</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1389">src/client/api.ts:1389</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#details" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>details</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#validator_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>validator_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1389">src/client/api.ts:1389</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#asset_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset_<wbr/>id</span></a><a href="#details" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>details</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#validator_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>validator_<wbr/>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.ValidatorList.html b/docs/interfaces/client_api.ValidatorList.html index 47a15f1a..5769480d 100644 --- a/docs/interfaces/client_api.ValidatorList.html +++ b/docs/interfaces/client_api.ValidatorList.html @@ -1,10 +1,10 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ValidatorList | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ValidatorList.html">ValidatorList</a></li></ul><h1>Interface ValidatorList</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ValidatorList</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ValidatorList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ValidatorList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ValidatorList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ValidatorList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1426">src/client/api.ts:1426</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ValidatorList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ValidatorList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ValidatorList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ValidatorList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.ValidatorList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1426">src/client/api.ts:1426</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.ValidatorList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> <a href="client_api.ValidatorList.html#has_more" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a> <a href="client_api.ValidatorList.html#next_page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ValidatorList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1432">src/client/api.ts:1432</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1432">src/client/api.ts:1432</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ValidatorList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1438">src/client/api.ts:1438</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1438">src/client/api.ts:1438</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>ValidatorList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1444">src/client/api.ts:1444</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1444">src/client/api.ts:1444</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.ValidatorsApiInterface.html b/docs/interfaces/client_api.ValidatorsApiInterface.html index 5f14d33b..ee68aff8 100644 --- a/docs/interfaces/client_api.ValidatorsApiInterface.html +++ b/docs/interfaces/client_api.ValidatorsApiInterface.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ValidatorsApiInterface | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ValidatorsApiInterface.html">ValidatorsApiInterface</a></li></ul><h1>Interface ValidatorsApiInterface</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ValidatorsApi - interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>ValidatorsApi</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ValidatorsApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ValidatorsApiInterface.html#getValidator.getValidator-1">getValidator</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">validatorId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ValidatorsApiInterface.html#listValidators.listValidators-1">listValidators</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.ValidatorsApi.html" class="tsd-signature-type tsd-kind-class">ValidatorsApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4749">src/client/api.ts:4749</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.ValidatorsApiInterface.html#getValidator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Validator</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ValidatorsApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ValidatorsApiInterface.html#getValidator.getValidator-1">getValidator</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">validatorId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.ValidatorsApiInterface.html#listValidators.listValidators-1">listValidators</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.ValidatorsApi.html" class="tsd-signature-type tsd-kind-class">ValidatorsApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4749">src/client/api.ts:4749</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.ValidatorsApiInterface.html#getValidator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Validator</span></a> <a href="client_api.ValidatorsApiInterface.html#listValidators" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Validators</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getValidator" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Validator</span><a href="#getValidator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getValidator.getValidator-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Validator</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">validatorId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">></span><a href="#getValidator.getValidator-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a validator belonging to the user for a given network, asset and id.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network.</p> @@ -9,7 +9,7 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get a validator belonging to the CDP project</p> <h4>Throws</h4><h4>Memberof</h4><p>ValidatorsApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4760">src/client/api.ts:4760</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listValidators" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Validators</span><a href="#listValidators" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listValidators.listValidators-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Validators</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span><a href="#listValidators.listValidators-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List validators belonging to the user for a given network and asset.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4760">src/client/api.ts:4760</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listValidators" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Validators</span><a href="#listValidators" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listValidators.listValidators-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Validators</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span><a href="#listValidators.listValidators-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List validators belonging to the user for a given network and asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to get the validators for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A filter to list validators based on a status.</p> @@ -18,4 +18,4 @@ <h4>Throws</h4><h4>Memberof</h4><p>ValidatorsApiInterface</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List validators belonging to the CDP project</p> <h4>Throws</h4><h4>Memberof</h4><p>ValidatorsApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L4774">src/client/api.ts:4774</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#getValidator" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Validator</span></a><a href="#listValidators" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Validators</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L4774">src/client/api.ts:4774</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#getValidator" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Validator</span></a><a href="#listValidators" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Validators</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.Wallet.html b/docs/interfaces/client_api.Wallet.html index 73aaa482..cb159462 100644 --- a/docs/interfaces/client_api.Wallet.html +++ b/docs/interfaces/client_api.Wallet.html @@ -1,16 +1,16 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Wallet | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.Wallet.html">Wallet</a></li></ul><h1>Interface Wallet</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>Wallet</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Wallet</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Wallet.html#default_address">default_address</a><span class="tsd-signature-symbol">?: </span><a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Wallet.html#enabled_features">enabled_features</a><span class="tsd-signature-symbol">: </span><a href="../enums/client_api.Feature.html" class="tsd-signature-type tsd-kind-enum">Feature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Wallet.html#id">id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Wallet.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Wallet.html#server_signer_status">server_signer_status</a><span class="tsd-signature-symbol">?: </span><a href="../types/client_api.WalletServerSignerStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">WalletServerSignerStatusEnum</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1451">src/client/api.ts:1451</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Wallet.html#default_address" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default_<wbr/>address?</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Wallet</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Wallet.html#default_address">default_address</a><span class="tsd-signature-symbol">?: </span><a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Wallet.html#enabled_features">enabled_features</a><span class="tsd-signature-symbol">: </span><a href="../enums/client_api.Feature.html" class="tsd-signature-type tsd-kind-enum">Feature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Wallet.html#id">id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Wallet.html#network_id">network_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.Wallet.html#server_signer_status">server_signer_status</a><span class="tsd-signature-symbol">?: </span><a href="../types/client_api.WalletServerSignerStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">WalletServerSignerStatusEnum</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1451">src/client/api.ts:1451</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.Wallet.html#default_address" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default_<wbr/>address?</span></a> <a href="client_api.Wallet.html#enabled_features" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enabled_<wbr/>features</span></a> <a href="client_api.Wallet.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a> <a href="client_api.Wallet.html#network_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a> <a href="client_api.Wallet.html#server_signer_status" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server_<wbr/>signer_<wbr/>status?</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="default_address" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>default_<wbr/>address</span><a href="#default_address" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">default_<wbr/>address</span><span class="tsd-signature-symbol">?:</span> <a href="client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Wallet</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1469">src/client/api.ts:1469</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="enabled_features" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enabled_<wbr/>features</span><a href="#enabled_features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enabled_<wbr/>features</span><span class="tsd-signature-symbol">:</span> <a href="../enums/client_api.Feature.html" class="tsd-signature-type tsd-kind-enum">Feature</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The features enabled for the wallet</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1469">src/client/api.ts:1469</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="enabled_features" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enabled_<wbr/>features</span><a href="#enabled_features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enabled_<wbr/>features</span><span class="tsd-signature-symbol">:</span> <a href="../enums/client_api.Feature.html" class="tsd-signature-type tsd-kind-enum">Feature</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The features enabled for the wallet</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Wallet</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1475">src/client/api.ts:1475</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The server-assigned ID for the wallet.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1475">src/client/api.ts:1475</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The server-assigned ID for the wallet.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Wallet</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1457">src/client/api.ts:1457</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1457">src/client/api.ts:1457</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="network_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network_<wbr/>id</span><a href="#network_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Wallet</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1463">src/client/api.ts:1463</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="server_signer_status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>server_<wbr/>signer_<wbr/>status</span><a href="#server_signer_status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">server_<wbr/>signer_<wbr/>status</span><span class="tsd-signature-symbol">?:</span> <a href="../types/client_api.WalletServerSignerStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">WalletServerSignerStatusEnum</a></div><div class="tsd-comment tsd-typography"><p>The status of the Server-Signer for the wallet if present.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1463">src/client/api.ts:1463</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="server_signer_status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>server_<wbr/>signer_<wbr/>status</span><a href="#server_signer_status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">server_<wbr/>signer_<wbr/>status</span><span class="tsd-signature-symbol">?:</span> <a href="../types/client_api.WalletServerSignerStatusEnum.html" class="tsd-signature-type tsd-kind-type-alias">WalletServerSignerStatusEnum</a></div><div class="tsd-comment tsd-typography"><p>The status of the Server-Signer for the wallet if present.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Wallet</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1481">src/client/api.ts:1481</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#default_address" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default_<wbr/>address</span></a><a href="#enabled_features" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enabled_<wbr/>features</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#server_signer_status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server_<wbr/>signer_<wbr/>status</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1481">src/client/api.ts:1481</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#default_address" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default_<wbr/>address</span></a><a href="#enabled_features" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enabled_<wbr/>features</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#network_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network_<wbr/>id</span></a><a href="#server_signer_status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server_<wbr/>signer_<wbr/>status</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.WalletList.html b/docs/interfaces/client_api.WalletList.html index 54898354..7c089c13 100644 --- a/docs/interfaces/client_api.WalletList.html +++ b/docs/interfaces/client_api.WalletList.html @@ -1,14 +1,14 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WalletList | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.WalletList.html">WalletList</a></li></ul><h1>Interface WalletList</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Paginated list of wallets</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>WalletList</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">WalletList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.WalletList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.WalletList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.WalletList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.WalletList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1496">src/client/api.ts:1496</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.WalletList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">WalletList</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_api.WalletList.html#data">data</a><span class="tsd-signature-symbol">: </span><a href="client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.WalletList.html#has_more">has_more</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.WalletList.html#next_page">next_page</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_api.WalletList.html#total_count">total_count</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1496">src/client/api.ts:1496</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_api.WalletList.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a> <a href="client_api.WalletList.html#has_more" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a> <a href="client_api.WalletList.html#next_page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a> <a href="client_api.WalletList.html#total_count" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <a href="client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>WalletList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1502">src/client/api.ts:1502</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1502">src/client/api.ts:1502</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_more" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has_<wbr/>more</span><a href="#has_more" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>more</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>True if this list has another page of items after this one that can be fetched.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>WalletList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1508">src/client/api.ts:1508</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1508">src/client/api.ts:1508</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next_page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next_<wbr/>page</span><a href="#next_page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next_<wbr/>page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The page token to be used to fetch the next page.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>WalletList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1514">src/client/api.ts:1514</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of wallets</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1514">src/client/api.ts:1514</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total_<wbr/>count</span><a href="#total_count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of wallets</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>WalletList</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1520">src/client/api.ts:1520</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1520">src/client/api.ts:1520</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#has_more" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>more</span></a><a href="#next_page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next_<wbr/>page</span></a><a href="#total_count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>count</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_api.WalletsApiInterface.html b/docs/interfaces/client_api.WalletsApiInterface.html index f10b0410..705285a8 100644 --- a/docs/interfaces/client_api.WalletsApiInterface.html +++ b/docs/interfaces/client_api.WalletsApiInterface.html @@ -1,6 +1,6 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WalletsApiInterface | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.WalletsApiInterface.html">WalletsApiInterface</a></li></ul><h1>Interface WalletsApiInterface</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>WalletsApi - interface</p> </div><div class="tsd-comment tsd-typography"><h4>Export</h4><p>WalletsApi</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">WalletsApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.WalletsApiInterface.html#createWallet.createWallet-1">createWallet</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createWalletRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.WalletsApiInterface.html#getWallet.getWallet-1">getWallet</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.WalletsApiInterface.html#getWalletBalance.getWalletBalance-1">getWalletBalance</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.WalletsApiInterface.html#listWalletBalances.listWalletBalances-1">listWalletBalances</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.WalletsApiInterface.html#listWallets.listWallets-1">listWallets</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.WalletsApi.html" class="tsd-signature-type tsd-kind-class">WalletsApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5151">src/client/api.ts:5151</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.WalletsApiInterface.html#createWallet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Wallet</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">WalletsApiInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.WalletsApiInterface.html#createWallet.createWallet-1">createWallet</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">createWalletRequest</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.WalletsApiInterface.html#getWallet.getWallet-1">getWallet</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.WalletsApiInterface.html#getWalletBalance.getWalletBalance-1">getWalletBalance</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.WalletsApiInterface.html#listWalletBalances.listWalletBalances-1">listWalletBalances</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="client_api.WalletsApiInterface.html#listWallets.listWallets-1">listWallets</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/client_api.WalletsApi.html" class="tsd-signature-type tsd-kind-class">WalletsApi</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5151">src/client/api.ts:5151</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="client_api.WalletsApiInterface.html#createWallet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Wallet</span></a> <a href="client_api.WalletsApiInterface.html#getWallet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet</span></a> <a href="client_api.WalletsApiInterface.html#getWalletBalance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet<wbr/>Balance</span></a> <a href="client_api.WalletsApiInterface.html#listWalletBalances" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallet<wbr/>Balances</span></a> @@ -9,26 +9,26 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createWalletRequest</span>: <a href="client_api.CreateWalletRequest.html" class="tsd-signature-type tsd-kind-interface">CreateWalletRequest</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Create a new wallet</p> <h4>Throws</h4><h4>Memberof</h4><p>WalletsApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5160">src/client/api.ts:5160</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet</span><a href="#getWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWallet.getWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><a href="#getWallet.getWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get wallet</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5160">src/client/api.ts:5160</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet</span><a href="#getWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWallet.getWallet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span><a href="#getWallet.getWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get wallet</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Wallet.html" class="tsd-signature-type tsd-kind-interface">Wallet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get wallet by ID</p> <h4>Throws</h4><h4>Memberof</h4><p>WalletsApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5170">src/client/api.ts:5170</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWalletBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet<wbr/>Balance</span><a href="#getWalletBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWalletBalance.getWalletBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><a href="#getWalletBalance.getWalletBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the aggregated balance of an asset across all of the addresses in the wallet.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5170">src/client/api.ts:5170</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWalletBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wallet<wbr/>Balance</span><a href="#getWalletBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWalletBalance.getWalletBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wallet<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><a href="#getWalletBalance.getWalletBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the aggregated balance of an asset across all of the addresses in the wallet.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the balance of an asset in the wallet</p> <h4>Throws</h4><h4>Memberof</h4><p>WalletsApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5181">src/client/api.ts:5181</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWalletBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Wallet<wbr/>Balances</span><a href="#listWalletBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWalletBalances.listWalletBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#listWalletBalances.listWalletBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the balances of all of the addresses in the wallet aggregated by asset.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5181">src/client/api.ts:5181</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWalletBalances" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Wallet<wbr/>Balances</span><a href="#listWalletBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWalletBalances.listWalletBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#listWalletBalances.listWalletBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the balances of all of the addresses in the wallet aggregated by asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balances for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List wallet balances</p> <h4>Throws</h4><h4>Memberof</h4><p>WalletsApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5191">src/client/api.ts:5191</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWallets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Wallets</span><a href="#listWallets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><a href="#listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List wallets belonging to the user.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5191">src/client/api.ts:5191</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWallets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Wallets</span><a href="#listWallets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><a href="#listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List wallets belonging to the user.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>List wallets</p> <h4>Throws</h4><h4>Memberof</h4><p>WalletsApiInterface</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L5202">src/client/api.ts:5202</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#createWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Wallet</span></a><a href="#getWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet</span></a><a href="#getWalletBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet<wbr/>Balance</span></a><a href="#listWalletBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallet<wbr/>Balances</span></a><a href="#listWallets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallets</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L5202">src/client/api.ts:5202</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#createWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Wallet</span></a><a href="#getWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet</span></a><a href="#getWalletBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wallet<wbr/>Balance</span></a><a href="#listWalletBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallet<wbr/>Balances</span></a><a href="#listWallets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Wallets</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_base.RequestArgs.html b/docs/interfaces/client_base.RequestArgs.html index 61821ef5..5a982b9e 100644 --- a/docs/interfaces/client_base.RequestArgs.html +++ b/docs/interfaces/client_base.RequestArgs.html @@ -1,4 +1,4 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RequestArgs | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_base.html">client/base</a></li><li><a href="client_base.RequestArgs.html">RequestArgs</a></li></ul><h1>Interface RequestArgs</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Export</h4><p>RequestArgs</p> -</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">RequestArgs</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_base.RequestArgs.html#options">options</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RawAxiosRequestConfig</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_base.RequestArgs.html#url">url</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L40">src/client/base.ts:40</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_base.RequestArgs.html#options" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a> +</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">RequestArgs</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_base.RequestArgs.html#options">options</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RawAxiosRequestConfig</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_base.RequestArgs.html#url">url</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L40">src/client/base.ts:40</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_base.RequestArgs.html#options" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a> <a href="client_base.RequestArgs.html#url" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>url</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RawAxiosRequestConfig</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L42">src/client/base.ts:42</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="url" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>url</span><a href="#url" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L41">src/client/base.ts:41</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#options" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a><a href="#url" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>url</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RawAxiosRequestConfig</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L42">src/client/base.ts:42</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="url" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>url</span><a href="#url" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L41">src/client/base.ts:41</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#options" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a><a href="#url" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>url</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/interfaces/client_configuration.ConfigurationParameters.html b/docs/interfaces/client_configuration.ConfigurationParameters.html index fe18fd3c..a5ad76af 100644 --- a/docs/interfaces/client_configuration.ConfigurationParameters.html +++ b/docs/interfaces/client_configuration.ConfigurationParameters.html @@ -5,7 +5,7 @@ <p>NOTE: This class is auto generated by OpenAPI Generator (<a href="https://openapi-generator.tech">https://openapi-generator.tech</a>). <a href="https://openapi-generator.tech">https://openapi-generator.tech</a> Do not edit the class manually.</p> -</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ConfigurationParameters</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#accessToken">accessToken</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#apiKey">apiKey</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#baseOptions">baseOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#basePath">basePath</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#formDataCtor">formDataCtor</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">new </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#password">password</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#serverIndex">serverIndex</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#username">username</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L16">src/client/configuration.ts:16</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_configuration.ConfigurationParameters.html#accessToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>access<wbr/>Token?</span></a> +</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ConfigurationParameters</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#accessToken">accessToken</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#apiKey">apiKey</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#baseOptions">baseOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#basePath">basePath</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#formDataCtor">formDataCtor</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">new </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#password">password</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#serverIndex">serverIndex</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="client_configuration.ConfigurationParameters.html#username">username</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L16">src/client/configuration.ts:16</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="client_configuration.ConfigurationParameters.html#accessToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>access<wbr/>Token?</span></a> <a href="client_configuration.ConfigurationParameters.html#apiKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key?</span></a> <a href="client_configuration.ConfigurationParameters.html#baseOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Options?</span></a> <a href="client_configuration.ConfigurationParameters.html#basePath" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path?</span></a> @@ -13,4 +13,4 @@ <a href="client_configuration.ConfigurationParameters.html#password" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>password?</span></a> <a href="client_configuration.ConfigurationParameters.html#serverIndex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Index?</span></a> <a href="client_configuration.ConfigurationParameters.html#username" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username?</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="accessToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>access<wbr/>Token</span><a href="#accessToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">access<wbr/>Token</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">scopes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">scopes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L20">src/client/configuration.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="apiKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api<wbr/>Key</span><a href="#apiKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L17">src/client/configuration.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="baseOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>base<wbr/>Options</span><a href="#baseOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L23">src/client/configuration.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L21">src/client/configuration.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="formDataCtor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>form<wbr/>Data<wbr/>Ctor</span><a href="#formDataCtor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">form<wbr/>Data<wbr/>Ctor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">new </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="formDataCtor.__type.new_formDataCtor"><span class="tsd-signature-keyword">new </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L24">src/client/configuration.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="password" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>password</span><a href="#password" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L19">src/client/configuration.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="serverIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>server<wbr/>Index</span><a href="#serverIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">server<wbr/>Index</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L22">src/client/configuration.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="username" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>username</span><a href="#username" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L18">src/client/configuration.ts:18</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#accessToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>access<wbr/>Token</span></a><a href="#apiKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key</span></a><a href="#baseOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Options</span></a><a href="#basePath" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#formDataCtor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Data<wbr/>Ctor</span></a><a href="#password" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>password</span></a><a href="#serverIndex" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Index</span></a><a href="#username" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="accessToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>access<wbr/>Token</span><a href="#accessToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">access<wbr/>Token</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">scopes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">scopes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L20">src/client/configuration.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="apiKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api<wbr/>Key</span><a href="#apiKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L17">src/client/configuration.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="baseOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>base<wbr/>Options</span><a href="#baseOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L23">src/client/configuration.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="basePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L21">src/client/configuration.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="formDataCtor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>form<wbr/>Data<wbr/>Ctor</span><a href="#formDataCtor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">form<wbr/>Data<wbr/>Ctor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">new </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="formDataCtor.__type.new_formDataCtor"><span class="tsd-signature-keyword">new </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L24">src/client/configuration.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="password" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>password</span><a href="#password" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L19">src/client/configuration.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="serverIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>server<wbr/>Index</span><a href="#serverIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">server<wbr/>Index</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L22">src/client/configuration.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="username" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>username</span><a href="#username" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L18">src/client/configuration.ts:18</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#accessToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>access<wbr/>Token</span></a><a href="#apiKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key</span></a><a href="#baseOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Options</span></a><a href="#basePath" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Path</span></a><a href="#formDataCtor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Data<wbr/>Ctor</span></a><a href="#password" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>password</span></a><a href="#serverIndex" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Index</span></a><a href="#username" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/client.html b/docs/modules/client.html index c97cbbda..68a51dcc 100644 --- a/docs/modules/client.html +++ b/docs/modules/client.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="client.html">client</a></li></ul><h1>Module client</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/index.ts#L1">src/client/index.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">References</h3><div class="tsd-index-list"><a href="client.html#Address" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Address</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="client.html">client</a></li></ul><h1>Module client</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/index.ts#L1">src/client/index.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">References</h3><div class="tsd-index-list"><a href="client.html#Address" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Address</span></a> <a href="client.html#AddressBalanceList" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Address<wbr/>Balance<wbr/>List</span></a> <a href="client.html#AddressList" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Address<wbr/>List</span></a> <a href="client.html#AddressesApi" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Addresses<wbr/>Api</span></a> diff --git a/docs/modules/client_api.html b/docs/modules/client_api.html index 4f6a8f71..4792b939 100644 --- a/docs/modules/client_api.html +++ b/docs/modules/client_api.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client/api | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="client_api.html">client/api</a></li></ul><h1>Module client/api</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1">src/client/api.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumerations</h3><div class="tsd-index-list"><a href="../enums/client_api.Feature.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Feature</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client/api | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="client_api.html">client/api</a></li></ul><h1>Module client/api</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1">src/client/api.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumerations</h3><div class="tsd-index-list"><a href="../enums/client_api.Feature.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Feature</span></a> <a href="../enums/client_api.StakingRewardFormat.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Staking<wbr/>Reward<wbr/>Format</span></a> <a href="../enums/client_api.TransactionType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Transaction<wbr/>Type</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/client_api.AddressesApi.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Addresses<wbr/>Api</span></a> diff --git a/docs/modules/client_base.html b/docs/modules/client_base.html index 2176c9ca..8265d9bd 100644 --- a/docs/modules/client_base.html +++ b/docs/modules/client_base.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client/base | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="client_base.html">client/base</a></li></ul><h1>Module client/base</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L1">src/client/base.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/client_base.BaseAPI.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>BaseAPI</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client/base | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="client_base.html">client/base</a></li></ul><h1>Module client/base</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L1">src/client/base.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/client_base.BaseAPI.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>BaseAPI</span></a> <a href="../classes/client_base.RequiredError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Required<wbr/>Error</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Interfaces</h3><div class="tsd-index-list"><a href="../interfaces/client_base.RequestArgs.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Request<wbr/>Args</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/client_base.BASE_PATH.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>BASE_<wbr/>PATH</span></a> diff --git a/docs/modules/client_common.html b/docs/modules/client_common.html index 4fe1b926..6438ef35 100644 --- a/docs/modules/client_common.html +++ b/docs/modules/client_common.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client/common | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="client_common.html">client/common</a></li></ul><h1>Module client/common</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/common.ts#L1">src/client/common.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/client_common.DUMMY_BASE_URL.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>DUMMY_<wbr/>BASE_<wbr/>URL</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client/common | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="client_common.html">client/common</a></li></ul><h1>Module client/common</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/common.ts#L1">src/client/common.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/client_common.DUMMY_BASE_URL.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>DUMMY_<wbr/>BASE_<wbr/>URL</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/client_common.assertParamExists.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>assert<wbr/>Param<wbr/>Exists</span></a> <a href="../functions/client_common.createRequestFunction.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>create<wbr/>Request<wbr/>Function</span></a> <a href="../functions/client_common.serializeDataIfNeeded.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>serialize<wbr/>Data<wbr/>If<wbr/>Needed</span></a> diff --git a/docs/modules/client_configuration.html b/docs/modules/client_configuration.html index 3f94432f..ac0cc950 100644 --- a/docs/modules/client_configuration.html +++ b/docs/modules/client_configuration.html @@ -1,3 +1,3 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client/configuration | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="client_configuration.html">client/configuration</a></li></ul><h1>Module client/configuration</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/configuration.ts#L1">src/client/configuration.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/client_configuration.Configuration.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Configuration</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client/configuration | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="client_configuration.html">client/configuration</a></li></ul><h1>Module client/configuration</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/configuration.ts#L1">src/client/configuration.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/client_configuration.Configuration.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Configuration</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Interfaces</h3><div class="tsd-index-list"><a href="../interfaces/client_configuration.ConfigurationParameters.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Configuration<wbr/>Parameters</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_address.html b/docs/modules/coinbase_address.html index 23705bc2..c134b0e8 100644 --- a/docs/modules/coinbase_address.html +++ b/docs/modules/coinbase_address.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/address | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_address.html">coinbase/address</a></li></ul><h1>Module coinbase/address</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address.ts#L1">src/coinbase/address.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_address.Address.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Address</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/address | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_address.html">coinbase/address</a></li></ul><h1>Module coinbase/address</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address.ts#L1">src/coinbase/address.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_address.Address.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Address</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_address_external_address.html b/docs/modules/coinbase_address_external_address.html index 6733e71c..4c8cb063 100644 --- a/docs/modules/coinbase_address_external_address.html +++ b/docs/modules/coinbase_address_external_address.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/address/external_address | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_address_external_address.html">coinbase/address/external_address</a></li></ul><h1>Module coinbase/address/external_address</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/external_address.ts#L1">src/coinbase/address/external_address.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_address_external_address.ExternalAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>External<wbr/>Address</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/address/external_address | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_address_external_address.html">coinbase/address/external_address</a></li></ul><h1>Module coinbase/address/external_address</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/external_address.ts#L1">src/coinbase/address/external_address.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_address_external_address.ExternalAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>External<wbr/>Address</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_address_wallet_address.html b/docs/modules/coinbase_address_wallet_address.html index e12ef7a0..4360b178 100644 --- a/docs/modules/coinbase_address_wallet_address.html +++ b/docs/modules/coinbase_address_wallet_address.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/address/wallet_address | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_address_wallet_address.html">coinbase/address/wallet_address</a></li></ul><h1>Module coinbase/address/wallet_address</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/address/wallet_address.ts#L1">src/coinbase/address/wallet_address.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_address_wallet_address.WalletAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Wallet<wbr/>Address</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/address/wallet_address | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_address_wallet_address.html">coinbase/address/wallet_address</a></li></ul><h1>Module coinbase/address/wallet_address</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/address/wallet_address.ts#L1">src/coinbase/address/wallet_address.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_address_wallet_address.WalletAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Wallet<wbr/>Address</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_api_error.html b/docs/modules/coinbase_api_error.html index 2ed6d4a3..a336f825 100644 --- a/docs/modules/coinbase_api_error.html +++ b/docs/modules/coinbase_api_error.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/api_error | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_api_error.html">coinbase/api_error</a></li></ul><h1>Module coinbase/api_error</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/api_error.ts#L1">src/coinbase/api_error.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_api_error.APIError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>APIError</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/api_error | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_api_error.html">coinbase/api_error</a></li></ul><h1>Module coinbase/api_error</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/api_error.ts#L1">src/coinbase/api_error.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_api_error.APIError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>APIError</span></a> <a href="../classes/coinbase_api_error.AlreadyExistsError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Already<wbr/>Exists<wbr/>Error</span></a> <a href="../classes/coinbase_api_error.FaucetLimitReachedError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Faucet<wbr/>Limit<wbr/>Reached<wbr/>Error</span></a> <a href="../classes/coinbase_api_error.InvalidAddressError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Invalid<wbr/>Address<wbr/>Error</span></a> diff --git a/docs/modules/coinbase_asset.html b/docs/modules/coinbase_asset.html index c099935a..9e731f3e 100644 --- a/docs/modules/coinbase_asset.html +++ b/docs/modules/coinbase_asset.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/asset | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_asset.html">coinbase/asset</a></li></ul><h1>Module coinbase/asset</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/asset.ts#L1">src/coinbase/asset.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_asset.Asset.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Asset</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/asset | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_asset.html">coinbase/asset</a></li></ul><h1>Module coinbase/asset</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/asset.ts#L1">src/coinbase/asset.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_asset.Asset.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Asset</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_authenticator.html b/docs/modules/coinbase_authenticator.html index ed865f8e..861286c7 100644 --- a/docs/modules/coinbase_authenticator.html +++ b/docs/modules/coinbase_authenticator.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/authenticator | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_authenticator.html">coinbase/authenticator</a></li></ul><h1>Module coinbase/authenticator</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/authenticator.ts#L1">src/coinbase/authenticator.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_authenticator.CoinbaseAuthenticator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Coinbase<wbr/>Authenticator</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/authenticator | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_authenticator.html">coinbase/authenticator</a></li></ul><h1>Module coinbase/authenticator</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/authenticator.ts#L1">src/coinbase/authenticator.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_authenticator.CoinbaseAuthenticator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Coinbase<wbr/>Authenticator</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_balance.html b/docs/modules/coinbase_balance.html index e3d57866..c15be5f7 100644 --- a/docs/modules/coinbase_balance.html +++ b/docs/modules/coinbase_balance.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/balance | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_balance.html">coinbase/balance</a></li></ul><h1>Module coinbase/balance</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/balance.ts#L1">src/coinbase/balance.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_balance.Balance.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Balance</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/balance | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_balance.html">coinbase/balance</a></li></ul><h1>Module coinbase/balance</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/balance.ts#L1">src/coinbase/balance.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_balance.Balance.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Balance</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_balance_map.html b/docs/modules/coinbase_balance_map.html index 664e71e8..ad2f16de 100644 --- a/docs/modules/coinbase_balance_map.html +++ b/docs/modules/coinbase_balance_map.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/balance_map | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_balance_map.html">coinbase/balance_map</a></li></ul><h1>Module coinbase/balance_map</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/balance_map.ts#L1">src/coinbase/balance_map.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_balance_map.BalanceMap.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Balance<wbr/>Map</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/balance_map | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_balance_map.html">coinbase/balance_map</a></li></ul><h1>Module coinbase/balance_map</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/balance_map.ts#L1">src/coinbase/balance_map.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_balance_map.BalanceMap.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Balance<wbr/>Map</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_coinbase.html b/docs/modules/coinbase_coinbase.html index f919e51c..ba3da1fa 100644 --- a/docs/modules/coinbase_coinbase.html +++ b/docs/modules/coinbase_coinbase.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/coinbase | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_coinbase.html">coinbase/coinbase</a></li></ul><h1>Module coinbase/coinbase</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/coinbase.ts#L1">src/coinbase/coinbase.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_coinbase.Coinbase.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Coinbase</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/coinbase | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_coinbase.html">coinbase/coinbase</a></li></ul><h1>Module coinbase/coinbase</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/coinbase.ts#L1">src/coinbase/coinbase.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_coinbase.Coinbase.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Coinbase</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_constants.html b/docs/modules/coinbase_constants.html index 178806ca..253dae7a 100644 --- a/docs/modules/coinbase_constants.html +++ b/docs/modules/coinbase_constants.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/constants | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_constants.html">coinbase/constants</a></li></ul><h1>Module coinbase/constants</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/constants.ts#L1">src/coinbase/constants.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ATOMIC_<wbr/>UNITS_<wbr/>PER_<wbr/>USDC</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/constants | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_constants.html">coinbase/constants</a></li></ul><h1>Module coinbase/constants</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/constants.ts#L1">src/coinbase/constants.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ATOMIC_<wbr/>UNITS_<wbr/>PER_<wbr/>USDC</span></a> <a href="../variables/coinbase_constants.GWEI_DECIMALS.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>GWEI_<wbr/>DECIMALS</span></a> <a href="../variables/coinbase_constants.WEI_PER_ETHER.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>WEI_<wbr/>PER_<wbr/>ETHER</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_errors.html b/docs/modules/coinbase_errors.html index 9094026f..13cbbd75 100644 --- a/docs/modules/coinbase_errors.html +++ b/docs/modules/coinbase_errors.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/errors | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_errors.html">coinbase/errors</a></li></ul><h1>Module coinbase/errors</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/errors.ts#L1">src/coinbase/errors.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_errors.ArgumentError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Argument<wbr/>Error</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/errors | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_errors.html">coinbase/errors</a></li></ul><h1>Module coinbase/errors</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/errors.ts#L1">src/coinbase/errors.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_errors.ArgumentError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Argument<wbr/>Error</span></a> <a href="../classes/coinbase_errors.InternalError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Internal<wbr/>Error</span></a> <a href="../classes/coinbase_errors.InvalidAPIKeyFormat.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>InvalidAPIKey<wbr/>Format</span></a> <a href="../classes/coinbase_errors.InvalidConfiguration.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Invalid<wbr/>Configuration</span></a> diff --git a/docs/modules/coinbase_faucet_transaction.html b/docs/modules/coinbase_faucet_transaction.html index 14a1840f..23bd184c 100644 --- a/docs/modules/coinbase_faucet_transaction.html +++ b/docs/modules/coinbase_faucet_transaction.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/faucet_transaction | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_faucet_transaction.html">coinbase/faucet_transaction</a></li></ul><h1>Module coinbase/faucet_transaction</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/faucet_transaction.ts#L1">src/coinbase/faucet_transaction.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Faucet<wbr/>Transaction</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/faucet_transaction | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_faucet_transaction.html">coinbase/faucet_transaction</a></li></ul><h1>Module coinbase/faucet_transaction</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/faucet_transaction.ts#L1">src/coinbase/faucet_transaction.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_faucet_transaction.FaucetTransaction.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Faucet<wbr/>Transaction</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_server_signer.html b/docs/modules/coinbase_server_signer.html index db12ba3c..555bdf99 100644 --- a/docs/modules/coinbase_server_signer.html +++ b/docs/modules/coinbase_server_signer.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/server_signer | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_server_signer.html">coinbase/server_signer</a></li></ul><h1>Module coinbase/server_signer</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/server_signer.ts#L1">src/coinbase/server_signer.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_server_signer.ServerSigner.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Server<wbr/>Signer</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/server_signer | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_server_signer.html">coinbase/server_signer</a></li></ul><h1>Module coinbase/server_signer</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/server_signer.ts#L1">src/coinbase/server_signer.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_server_signer.ServerSigner.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Server<wbr/>Signer</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_staking_operation.html b/docs/modules/coinbase_staking_operation.html index c14c9e2b..91e2bbb8 100644 --- a/docs/modules/coinbase_staking_operation.html +++ b/docs/modules/coinbase_staking_operation.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/staking_operation | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_staking_operation.html">coinbase/staking_operation</a></li></ul><h1>Module coinbase/staking_operation</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_operation.ts#L1">src/coinbase/staking_operation.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_staking_operation.StakingOperation.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Staking<wbr/>Operation</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/staking_operation | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_staking_operation.html">coinbase/staking_operation</a></li></ul><h1>Module coinbase/staking_operation</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_operation.ts#L1">src/coinbase/staking_operation.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_staking_operation.StakingOperation.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Staking<wbr/>Operation</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_staking_reward.html b/docs/modules/coinbase_staking_reward.html index a0e81077..2ff883ba 100644 --- a/docs/modules/coinbase_staking_reward.html +++ b/docs/modules/coinbase_staking_reward.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/staking_reward | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_staking_reward.html">coinbase/staking_reward</a></li></ul><h1>Module coinbase/staking_reward</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/staking_reward.ts#L1">src/coinbase/staking_reward.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_staking_reward.StakingReward.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Staking<wbr/>Reward</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/staking_reward | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_staking_reward.html">coinbase/staking_reward</a></li></ul><h1>Module coinbase/staking_reward</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/staking_reward.ts#L1">src/coinbase/staking_reward.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_staking_reward.StakingReward.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Staking<wbr/>Reward</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_trade.html b/docs/modules/coinbase_trade.html index 66d2396c..7d122748 100644 --- a/docs/modules/coinbase_trade.html +++ b/docs/modules/coinbase_trade.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/trade | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_trade.html">coinbase/trade</a></li></ul><h1>Module coinbase/trade</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/trade.ts#L1">src/coinbase/trade.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_trade.Trade.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Trade</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/trade | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_trade.html">coinbase/trade</a></li></ul><h1>Module coinbase/trade</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/trade.ts#L1">src/coinbase/trade.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_trade.Trade.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Trade</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_transaction.html b/docs/modules/coinbase_transaction.html index 296c1f9e..a69a87aa 100644 --- a/docs/modules/coinbase_transaction.html +++ b/docs/modules/coinbase_transaction.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/transaction | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_transaction.html">coinbase/transaction</a></li></ul><h1>Module coinbase/transaction</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transaction.ts#L1">src/coinbase/transaction.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_transaction.Transaction.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Transaction</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/transaction | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_transaction.html">coinbase/transaction</a></li></ul><h1>Module coinbase/transaction</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transaction.ts#L1">src/coinbase/transaction.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_transaction.Transaction.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Transaction</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_transfer.html b/docs/modules/coinbase_transfer.html index 7727f635..738f80ed 100644 --- a/docs/modules/coinbase_transfer.html +++ b/docs/modules/coinbase_transfer.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/transfer | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_transfer.html">coinbase/transfer</a></li></ul><h1>Module coinbase/transfer</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/transfer.ts#L1">src/coinbase/transfer.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_transfer.Transfer.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Transfer</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/transfer | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_transfer.html">coinbase/transfer</a></li></ul><h1>Module coinbase/transfer</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/transfer.ts#L1">src/coinbase/transfer.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_transfer.Transfer.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Transfer</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_types.html b/docs/modules/coinbase_types.html index 0e347a9a..96acfa08 100644 --- a/docs/modules/coinbase_types.html +++ b/docs/modules/coinbase_types.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/types | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_types.html">coinbase/types</a></li></ul><h1>Module coinbase/types</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L1">src/coinbase/types.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumerations</h3><div class="tsd-index-list"><a href="../enums/coinbase_types.ServerSignerStatus.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Server<wbr/>Signer<wbr/>Status</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/types | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_types.html">coinbase/types</a></li></ul><h1>Module coinbase/types</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L1">src/coinbase/types.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumerations</h3><div class="tsd-index-list"><a href="../enums/coinbase_types.ServerSignerStatus.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Server<wbr/>Signer<wbr/>Status</span></a> <a href="../enums/coinbase_types.StakeOptionsMode.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Stake<wbr/>Options<wbr/>Mode</span></a> <a href="../enums/coinbase_types.TransactionStatus.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Transaction<wbr/>Status</span></a> <a href="../enums/coinbase_types.TransferStatus.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Transfer<wbr/>Status</span></a> @@ -8,6 +8,7 @@ <a href="../types/coinbase_types.AssetAPIClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>AssetAPIClient</span></a> <a href="../types/coinbase_types.CoinbaseConfigureFromJsonOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Coinbase<wbr/>Configure<wbr/>From<wbr/>Json<wbr/>Options</span></a> <a href="../types/coinbase_types.CoinbaseOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Coinbase<wbr/>Options</span></a> +<a href="../types/coinbase_types.CreateTradeOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Create<wbr/>Trade<wbr/>Options</span></a> <a href="../types/coinbase_types.CreateTransferOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Create<wbr/>Transfer<wbr/>Options</span></a> <a href="../types/coinbase_types.Destination.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Destination</span></a> <a href="../types/coinbase_types.ExternalAddressAPIClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>External<wbr/>AddressAPIClient</span></a> diff --git a/docs/modules/coinbase_user.html b/docs/modules/coinbase_user.html index 8a929931..3f8acb1e 100644 --- a/docs/modules/coinbase_user.html +++ b/docs/modules/coinbase_user.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/user | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_user.html">coinbase/user</a></li></ul><h1>Module coinbase/user</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/user.ts#L1">src/coinbase/user.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_user.User.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>User</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/user | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_user.html">coinbase/user</a></li></ul><h1>Module coinbase/user</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/user.ts#L1">src/coinbase/user.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_user.User.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>User</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_utils.html b/docs/modules/coinbase_utils.html index 36e4421e..67b017f3 100644 --- a/docs/modules/coinbase_utils.html +++ b/docs/modules/coinbase_utils.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/utils | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_utils.html">coinbase/utils</a></li></ul><h1>Module coinbase/utils</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/utils.ts#L1">src/coinbase/utils.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/coinbase_utils.convertStringToHex.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>convert<wbr/>String<wbr/>To<wbr/>Hex</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/utils | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_utils.html">coinbase/utils</a></li></ul><h1>Module coinbase/utils</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/utils.ts#L1">src/coinbase/utils.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/coinbase_utils.convertStringToHex.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>convert<wbr/>String<wbr/>To<wbr/>Hex</span></a> <a href="../functions/coinbase_utils.delay.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>delay</span></a> <a href="../functions/coinbase_utils.logApiResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>log<wbr/>Api<wbr/>Response</span></a> <a href="../functions/coinbase_utils.parseUnsignedPayload.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>parse<wbr/>Unsigned<wbr/>Payload</span></a> diff --git a/docs/modules/coinbase_validator.html b/docs/modules/coinbase_validator.html index 5b39652e..4adefaad 100644 --- a/docs/modules/coinbase_validator.html +++ b/docs/modules/coinbase_validator.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/validator | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_validator.html">coinbase/validator</a></li></ul><h1>Module coinbase/validator</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/validator.ts#L1">src/coinbase/validator.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_validator.Validator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Validator</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/validator | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_validator.html">coinbase/validator</a></li></ul><h1>Module coinbase/validator</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/validator.ts#L1">src/coinbase/validator.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_validator.Validator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Validator</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/coinbase_wallet.html b/docs/modules/coinbase_wallet.html index 2d27b8c6..a044d303 100644 --- a/docs/modules/coinbase_wallet.html +++ b/docs/modules/coinbase_wallet.html @@ -1,2 +1,2 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/wallet | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_wallet.html">coinbase/wallet</a></li></ul><h1>Module coinbase/wallet</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/wallet.ts#L1">src/coinbase/wallet.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_wallet.Wallet.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Wallet</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>coinbase/wallet | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="coinbase_wallet.html">coinbase/wallet</a></li></ul><h1>Module coinbase/wallet</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/wallet.ts#L1">src/coinbase/wallet.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/coinbase_wallet.Wallet.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Wallet</span></a> </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html index 05ee17fa..68e0c5ed 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,4 +1,4 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>index | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="index.html">index</a></li></ul><h1>Module index</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/index.ts#L1">src/index.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">References</h3><div class="tsd-index-list"><a href="index.html#ATOMIC_UNITS_PER_USDC" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>ATOMIC_<wbr/>UNITS_<wbr/>PER_<wbr/>USDC</span></a> +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>index | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="index.html">index</a></li></ul><h1>Module index</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/index.ts#L1">src/index.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">References</h3><div class="tsd-index-list"><a href="index.html#ATOMIC_UNITS_PER_USDC" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>ATOMIC_<wbr/>UNITS_<wbr/>PER_<wbr/>USDC</span></a> <a href="index.html#Address" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Address</span></a> <a href="index.html#AddressAPIClient" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>AddressAPIClient</span></a> <a href="index.html#Amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Amount</span></a> @@ -11,6 +11,7 @@ <a href="index.html#Coinbase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Coinbase</span></a> <a href="index.html#CoinbaseConfigureFromJsonOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Coinbase<wbr/>Configure<wbr/>From<wbr/>Json<wbr/>Options</span></a> <a href="index.html#CoinbaseOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Coinbase<wbr/>Options</span></a> +<a href="index.html#CreateTradeOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Create<wbr/>Trade<wbr/>Options</span></a> <a href="index.html#CreateTransferOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Create<wbr/>Transfer<wbr/>Options</span></a> <a href="index.html#Destination" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Destination</span></a> <a href="index.html#ExternalAddress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>External<wbr/>Address</span></a> @@ -38,6 +39,7 @@ <a href="index.html#TransferStatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Transfer<wbr/>Status</span></a> <a href="index.html#User" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>User</span></a> <a href="index.html#UserAPIClient" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>UserAPIClient</span></a> +<a href="index.html#Validator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Validator</span></a> <a href="index.html#ValidatorAPIClient" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>ValidatorAPIClient</span></a> <a href="index.html#WEI_PER_ETHER" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>WEI_<wbr/>PER_<wbr/>ETHER</span></a> <a href="index.html#Wallet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Wallet</span></a> @@ -45,4 +47,4 @@ <a href="index.html#WalletAddress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Wallet<wbr/>Address</span></a> <a href="index.html#WalletCreateOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Wallet<wbr/>Create<wbr/>Options</span></a> <a href="index.html#WalletData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Wallet<wbr/>Data</span></a> -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>References</h2><section class="tsd-panel tsd-member"><a id="ATOMIC_UNITS_PER_USDC" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ATOMIC_<wbr/>UNITS_<wbr/>PER_<wbr/>USDC</span><a href="#ATOMIC_UNITS_PER_USDC" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html">ATOMIC_UNITS_PER_USDC</a></section><section class="tsd-panel tsd-member"><a id="Address" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Address</span><a href="#Address" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_address.Address.html">Address</a></section><section class="tsd-panel tsd-member"><a id="AddressAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>AddressAPIClient</span><a href="#AddressAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.AddressAPIClient.html">AddressAPIClient</a></section><section class="tsd-panel tsd-member"><a id="Amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Amount</span><a href="#Amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.Amount.html">Amount</a></section><section class="tsd-panel tsd-member"><a id="ApiClients" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Api<wbr/>Clients</span><a href="#ApiClients" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.ApiClients.html">ApiClients</a></section><section class="tsd-panel tsd-member"><a id="ArgumentError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Argument<wbr/>Error</span><a href="#ArgumentError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_errors.ArgumentError.html">ArgumentError</a></section><section class="tsd-panel tsd-member"><a id="Asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Asset</span><a href="#Asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_asset.Asset.html">Asset</a></section><section class="tsd-panel tsd-member"><a id="AssetAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>AssetAPIClient</span><a href="#AssetAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.AssetAPIClient.html">AssetAPIClient</a></section><section class="tsd-panel tsd-member"><a id="Balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Balance</span><a href="#Balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_balance.Balance.html">Balance</a></section><section class="tsd-panel tsd-member"><a id="BalanceMap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Balance<wbr/>Map</span><a href="#BalanceMap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_balance_map.BalanceMap.html">BalanceMap</a></section><section class="tsd-panel tsd-member"><a id="Coinbase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Coinbase</span><a href="#Coinbase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_coinbase.Coinbase.html">Coinbase</a></section><section class="tsd-panel tsd-member"><a id="CoinbaseConfigureFromJsonOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Coinbase<wbr/>Configure<wbr/>From<wbr/>Json<wbr/>Options</span><a href="#CoinbaseConfigureFromJsonOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.CoinbaseConfigureFromJsonOptions.html">CoinbaseConfigureFromJsonOptions</a></section><section class="tsd-panel tsd-member"><a id="CoinbaseOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Coinbase<wbr/>Options</span><a href="#CoinbaseOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.CoinbaseOptions.html">CoinbaseOptions</a></section><section class="tsd-panel tsd-member"><a id="CreateTransferOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Create<wbr/>Transfer<wbr/>Options</span><a href="#CreateTransferOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.CreateTransferOptions.html">CreateTransferOptions</a></section><section class="tsd-panel tsd-member"><a id="Destination" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Destination</span><a href="#Destination" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.Destination.html">Destination</a></section><section class="tsd-panel tsd-member"><a id="ExternalAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>External<wbr/>Address</span><a href="#ExternalAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_address_external_address.ExternalAddress.html">ExternalAddress</a></section><section class="tsd-panel tsd-member"><a id="ExternalAddressAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>External<wbr/>AddressAPIClient</span><a href="#ExternalAddressAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.ExternalAddressAPIClient.html">ExternalAddressAPIClient</a></section><section class="tsd-panel tsd-member"><a id="FaucetTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Faucet<wbr/>Transaction</span><a href="#FaucetTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_faucet_transaction.FaucetTransaction.html">FaucetTransaction</a></section><section class="tsd-panel tsd-member"><a id="GWEI_DECIMALS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>GWEI_<wbr/>DECIMALS</span><a href="#GWEI_DECIMALS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../variables/coinbase_constants.GWEI_DECIMALS.html">GWEI_DECIMALS</a></section><section class="tsd-panel tsd-member"><a id="InternalError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Internal<wbr/>Error</span><a href="#InternalError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_errors.InternalError.html">InternalError</a></section><section class="tsd-panel tsd-member"><a id="InvalidAPIKeyFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>InvalidAPIKey<wbr/>Format</span><a href="#InvalidAPIKeyFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_errors.InvalidAPIKeyFormat.html">InvalidAPIKeyFormat</a></section><section class="tsd-panel tsd-member"><a id="InvalidConfiguration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Invalid<wbr/>Configuration</span><a href="#InvalidConfiguration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_errors.InvalidConfiguration.html">InvalidConfiguration</a></section><section class="tsd-panel tsd-member"><a id="InvalidUnsignedPayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Invalid<wbr/>Unsigned<wbr/>Payload</span><a href="#InvalidUnsignedPayload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_errors.InvalidUnsignedPayload.html">InvalidUnsignedPayload</a></section><section class="tsd-panel tsd-member"><a id="SeedData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Seed<wbr/>Data</span><a href="#SeedData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.SeedData.html">SeedData</a></section><section class="tsd-panel tsd-member"><a id="ServerSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Server<wbr/>Signer</span><a href="#ServerSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_server_signer.ServerSigner.html">ServerSigner</a></section><section class="tsd-panel tsd-member"><a id="ServerSignerAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Server<wbr/>SignerAPIClient</span><a href="#ServerSignerAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.ServerSignerAPIClient.html">ServerSignerAPIClient</a></section><section class="tsd-panel tsd-member"><a id="ServerSignerStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Server<wbr/>Signer<wbr/>Status</span><a href="#ServerSignerStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../enums/coinbase_types.ServerSignerStatus.html">ServerSignerStatus</a></section><section class="tsd-panel tsd-member"><a id="StakeAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>StakeAPIClient</span><a href="#StakeAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.StakeAPIClient.html">StakeAPIClient</a></section><section class="tsd-panel tsd-member"><a id="StakeOptionsMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Stake<wbr/>Options<wbr/>Mode</span><a href="#StakeOptionsMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../enums/coinbase_types.StakeOptionsMode.html">StakeOptionsMode</a></section><section class="tsd-panel tsd-member"><a id="StakingOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Staking<wbr/>Operation</span><a href="#StakingOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_staking_operation.StakingOperation.html">StakingOperation</a></section><section class="tsd-panel tsd-member"><a id="StakingReward" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Staking<wbr/>Reward</span><a href="#StakingReward" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_staking_reward.StakingReward.html">StakingReward</a></section><section class="tsd-panel tsd-member"><a id="Trade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Trade</span><a href="#Trade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_trade.Trade.html">Trade</a></section><section class="tsd-panel tsd-member"><a id="TradeApiClients" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Trade<wbr/>Api<wbr/>Clients</span><a href="#TradeApiClients" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.TradeApiClients.html">TradeApiClients</a></section><section class="tsd-panel tsd-member"><a id="Transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Transaction</span><a href="#Transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_transaction.Transaction.html">Transaction</a></section><section class="tsd-panel tsd-member"><a id="TransactionStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Transaction<wbr/>Status</span><a href="#TransactionStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../enums/coinbase_types.TransactionStatus.html">TransactionStatus</a></section><section class="tsd-panel tsd-member"><a id="Transfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Transfer</span><a href="#Transfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_transfer.Transfer.html">Transfer</a></section><section class="tsd-panel tsd-member"><a id="TransferAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>TransferAPIClient</span><a href="#TransferAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.TransferAPIClient.html">TransferAPIClient</a></section><section class="tsd-panel tsd-member"><a id="TransferStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Transfer<wbr/>Status</span><a href="#TransferStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../enums/coinbase_types.TransferStatus.html">TransferStatus</a></section><section class="tsd-panel tsd-member"><a id="User" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>User</span><a href="#User" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_user.User.html">User</a></section><section class="tsd-panel tsd-member"><a id="UserAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>UserAPIClient</span><a href="#UserAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.UserAPIClient.html">UserAPIClient</a></section><section class="tsd-panel tsd-member"><a id="ValidatorAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ValidatorAPIClient</span><a href="#ValidatorAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.ValidatorAPIClient.html">ValidatorAPIClient</a></section><section class="tsd-panel tsd-member"><a id="WEI_PER_ETHER" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>WEI_<wbr/>PER_<wbr/>ETHER</span><a href="#WEI_PER_ETHER" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../variables/coinbase_constants.WEI_PER_ETHER.html">WEI_PER_ETHER</a></section><section class="tsd-panel tsd-member"><a id="Wallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Wallet</span><a href="#Wallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_wallet.Wallet.html">Wallet</a></section><section class="tsd-panel tsd-member"><a id="WalletAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>WalletAPIClient</span><a href="#WalletAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.WalletAPIClient.html">WalletAPIClient</a></section><section class="tsd-panel tsd-member"><a id="WalletAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Wallet<wbr/>Address</span><a href="#WalletAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_address_wallet_address.WalletAddress.html">WalletAddress</a></section><section class="tsd-panel tsd-member"><a id="WalletCreateOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Wallet<wbr/>Create<wbr/>Options</span><a href="#WalletCreateOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.WalletCreateOptions.html">WalletCreateOptions</a></section><section class="tsd-panel tsd-member"><a id="WalletData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Wallet<wbr/>Data</span><a href="#WalletData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.WalletData.html">WalletData</a></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#ATOMIC_UNITS_PER_USDC" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>ATOMIC_<wbr/>UNITS_<wbr/>PER_<wbr/>USDC</span></a><a href="#Address" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Address</span></a><a href="#AddressAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>AddressAPIClient</span></a><a href="#Amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Amount</span></a><a href="#ApiClients" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Api<wbr/>Clients</span></a><a href="#ArgumentError" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Argument<wbr/>Error</span></a><a href="#Asset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Asset</span></a><a href="#AssetAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>AssetAPIClient</span></a><a href="#Balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Balance</span></a><a href="#BalanceMap" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Balance<wbr/>Map</span></a><a href="#Coinbase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Coinbase</span></a><a href="#CoinbaseConfigureFromJsonOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Coinbase<wbr/>Configure<wbr/>From<wbr/>Json<wbr/>Options</span></a><a href="#CoinbaseOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Coinbase<wbr/>Options</span></a><a href="#CreateTransferOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Create<wbr/>Transfer<wbr/>Options</span></a><a href="#Destination" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Destination</span></a><a href="#ExternalAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>External<wbr/>Address</span></a><a href="#ExternalAddressAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>External<wbr/>AddressAPIClient</span></a><a href="#FaucetTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Faucet<wbr/>Transaction</span></a><a href="#GWEI_DECIMALS" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>GWEI_<wbr/>DECIMALS</span></a><a href="#InternalError" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Internal<wbr/>Error</span></a><a href="#InvalidAPIKeyFormat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>InvalidAPIKey<wbr/>Format</span></a><a href="#InvalidConfiguration" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Invalid<wbr/>Configuration</span></a><a href="#InvalidUnsignedPayload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Invalid<wbr/>Unsigned<wbr/>Payload</span></a><a href="#SeedData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Seed<wbr/>Data</span></a><a href="#ServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Server<wbr/>Signer</span></a><a href="#ServerSignerAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Server<wbr/>SignerAPIClient</span></a><a href="#ServerSignerStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Server<wbr/>Signer<wbr/>Status</span></a><a href="#StakeAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>StakeAPIClient</span></a><a href="#StakeOptionsMode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Stake<wbr/>Options<wbr/>Mode</span></a><a href="#StakingOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Staking<wbr/>Operation</span></a><a href="#StakingReward" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Staking<wbr/>Reward</span></a><a href="#Trade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Trade</span></a><a href="#TradeApiClients" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Trade<wbr/>Api<wbr/>Clients</span></a><a href="#Transaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Transaction</span></a><a href="#TransactionStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Transaction<wbr/>Status</span></a><a href="#Transfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Transfer</span></a><a href="#TransferAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>TransferAPIClient</span></a><a href="#TransferStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Transfer<wbr/>Status</span></a><a href="#User" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>User</span></a><a href="#UserAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>UserAPIClient</span></a><a href="#ValidatorAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>ValidatorAPIClient</span></a><a href="#WEI_PER_ETHER" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>WEI_<wbr/>PER_<wbr/>ETHER</span></a><a href="#Wallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Wallet</span></a><a href="#WalletAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>WalletAPIClient</span></a><a href="#WalletAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Wallet<wbr/>Address</span></a><a href="#WalletCreateOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Wallet<wbr/>Create<wbr/>Options</span></a><a href="#WalletData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Wallet<wbr/>Data</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>References</h2><section class="tsd-panel tsd-member"><a id="ATOMIC_UNITS_PER_USDC" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ATOMIC_<wbr/>UNITS_<wbr/>PER_<wbr/>USDC</span><a href="#ATOMIC_UNITS_PER_USDC" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html">ATOMIC_UNITS_PER_USDC</a></section><section class="tsd-panel tsd-member"><a id="Address" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Address</span><a href="#Address" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_address.Address.html">Address</a></section><section class="tsd-panel tsd-member"><a id="AddressAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>AddressAPIClient</span><a href="#AddressAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.AddressAPIClient.html">AddressAPIClient</a></section><section class="tsd-panel tsd-member"><a id="Amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Amount</span><a href="#Amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.Amount.html">Amount</a></section><section class="tsd-panel tsd-member"><a id="ApiClients" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Api<wbr/>Clients</span><a href="#ApiClients" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.ApiClients.html">ApiClients</a></section><section class="tsd-panel tsd-member"><a id="ArgumentError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Argument<wbr/>Error</span><a href="#ArgumentError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_errors.ArgumentError.html">ArgumentError</a></section><section class="tsd-panel tsd-member"><a id="Asset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Asset</span><a href="#Asset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_asset.Asset.html">Asset</a></section><section class="tsd-panel tsd-member"><a id="AssetAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>AssetAPIClient</span><a href="#AssetAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.AssetAPIClient.html">AssetAPIClient</a></section><section class="tsd-panel tsd-member"><a id="Balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Balance</span><a href="#Balance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_balance.Balance.html">Balance</a></section><section class="tsd-panel tsd-member"><a id="BalanceMap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Balance<wbr/>Map</span><a href="#BalanceMap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_balance_map.BalanceMap.html">BalanceMap</a></section><section class="tsd-panel tsd-member"><a id="Coinbase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Coinbase</span><a href="#Coinbase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_coinbase.Coinbase.html">Coinbase</a></section><section class="tsd-panel tsd-member"><a id="CoinbaseConfigureFromJsonOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Coinbase<wbr/>Configure<wbr/>From<wbr/>Json<wbr/>Options</span><a href="#CoinbaseConfigureFromJsonOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.CoinbaseConfigureFromJsonOptions.html">CoinbaseConfigureFromJsonOptions</a></section><section class="tsd-panel tsd-member"><a id="CoinbaseOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Coinbase<wbr/>Options</span><a href="#CoinbaseOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.CoinbaseOptions.html">CoinbaseOptions</a></section><section class="tsd-panel tsd-member"><a id="CreateTradeOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Create<wbr/>Trade<wbr/>Options</span><a href="#CreateTradeOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.CreateTradeOptions.html">CreateTradeOptions</a></section><section class="tsd-panel tsd-member"><a id="CreateTransferOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Create<wbr/>Transfer<wbr/>Options</span><a href="#CreateTransferOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.CreateTransferOptions.html">CreateTransferOptions</a></section><section class="tsd-panel tsd-member"><a id="Destination" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Destination</span><a href="#Destination" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.Destination.html">Destination</a></section><section class="tsd-panel tsd-member"><a id="ExternalAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>External<wbr/>Address</span><a href="#ExternalAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_address_external_address.ExternalAddress.html">ExternalAddress</a></section><section class="tsd-panel tsd-member"><a id="ExternalAddressAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>External<wbr/>AddressAPIClient</span><a href="#ExternalAddressAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.ExternalAddressAPIClient.html">ExternalAddressAPIClient</a></section><section class="tsd-panel tsd-member"><a id="FaucetTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Faucet<wbr/>Transaction</span><a href="#FaucetTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_faucet_transaction.FaucetTransaction.html">FaucetTransaction</a></section><section class="tsd-panel tsd-member"><a id="GWEI_DECIMALS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>GWEI_<wbr/>DECIMALS</span><a href="#GWEI_DECIMALS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../variables/coinbase_constants.GWEI_DECIMALS.html">GWEI_DECIMALS</a></section><section class="tsd-panel tsd-member"><a id="InternalError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Internal<wbr/>Error</span><a href="#InternalError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_errors.InternalError.html">InternalError</a></section><section class="tsd-panel tsd-member"><a id="InvalidAPIKeyFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>InvalidAPIKey<wbr/>Format</span><a href="#InvalidAPIKeyFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_errors.InvalidAPIKeyFormat.html">InvalidAPIKeyFormat</a></section><section class="tsd-panel tsd-member"><a id="InvalidConfiguration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Invalid<wbr/>Configuration</span><a href="#InvalidConfiguration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_errors.InvalidConfiguration.html">InvalidConfiguration</a></section><section class="tsd-panel tsd-member"><a id="InvalidUnsignedPayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Invalid<wbr/>Unsigned<wbr/>Payload</span><a href="#InvalidUnsignedPayload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_errors.InvalidUnsignedPayload.html">InvalidUnsignedPayload</a></section><section class="tsd-panel tsd-member"><a id="SeedData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Seed<wbr/>Data</span><a href="#SeedData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.SeedData.html">SeedData</a></section><section class="tsd-panel tsd-member"><a id="ServerSigner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Server<wbr/>Signer</span><a href="#ServerSigner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_server_signer.ServerSigner.html">ServerSigner</a></section><section class="tsd-panel tsd-member"><a id="ServerSignerAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Server<wbr/>SignerAPIClient</span><a href="#ServerSignerAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.ServerSignerAPIClient.html">ServerSignerAPIClient</a></section><section class="tsd-panel tsd-member"><a id="ServerSignerStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Server<wbr/>Signer<wbr/>Status</span><a href="#ServerSignerStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../enums/coinbase_types.ServerSignerStatus.html">ServerSignerStatus</a></section><section class="tsd-panel tsd-member"><a id="StakeAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>StakeAPIClient</span><a href="#StakeAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.StakeAPIClient.html">StakeAPIClient</a></section><section class="tsd-panel tsd-member"><a id="StakeOptionsMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Stake<wbr/>Options<wbr/>Mode</span><a href="#StakeOptionsMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../enums/coinbase_types.StakeOptionsMode.html">StakeOptionsMode</a></section><section class="tsd-panel tsd-member"><a id="StakingOperation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Staking<wbr/>Operation</span><a href="#StakingOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_staking_operation.StakingOperation.html">StakingOperation</a></section><section class="tsd-panel tsd-member"><a id="StakingReward" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Staking<wbr/>Reward</span><a href="#StakingReward" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_staking_reward.StakingReward.html">StakingReward</a></section><section class="tsd-panel tsd-member"><a id="Trade" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Trade</span><a href="#Trade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_trade.Trade.html">Trade</a></section><section class="tsd-panel tsd-member"><a id="TradeApiClients" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Trade<wbr/>Api<wbr/>Clients</span><a href="#TradeApiClients" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.TradeApiClients.html">TradeApiClients</a></section><section class="tsd-panel tsd-member"><a id="Transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Transaction</span><a href="#Transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_transaction.Transaction.html">Transaction</a></section><section class="tsd-panel tsd-member"><a id="TransactionStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Transaction<wbr/>Status</span><a href="#TransactionStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../enums/coinbase_types.TransactionStatus.html">TransactionStatus</a></section><section class="tsd-panel tsd-member"><a id="Transfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Transfer</span><a href="#Transfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_transfer.Transfer.html">Transfer</a></section><section class="tsd-panel tsd-member"><a id="TransferAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>TransferAPIClient</span><a href="#TransferAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.TransferAPIClient.html">TransferAPIClient</a></section><section class="tsd-panel tsd-member"><a id="TransferStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Transfer<wbr/>Status</span><a href="#TransferStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../enums/coinbase_types.TransferStatus.html">TransferStatus</a></section><section class="tsd-panel tsd-member"><a id="User" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>User</span><a href="#User" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_user.User.html">User</a></section><section class="tsd-panel tsd-member"><a id="UserAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>UserAPIClient</span><a href="#UserAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.UserAPIClient.html">UserAPIClient</a></section><section class="tsd-panel tsd-member"><a id="Validator" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Validator</span><a href="#Validator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_validator.Validator.html">Validator</a></section><section class="tsd-panel tsd-member"><a id="ValidatorAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ValidatorAPIClient</span><a href="#ValidatorAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.ValidatorAPIClient.html">ValidatorAPIClient</a></section><section class="tsd-panel tsd-member"><a id="WEI_PER_ETHER" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>WEI_<wbr/>PER_<wbr/>ETHER</span><a href="#WEI_PER_ETHER" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../variables/coinbase_constants.WEI_PER_ETHER.html">WEI_PER_ETHER</a></section><section class="tsd-panel tsd-member"><a id="Wallet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Wallet</span><a href="#Wallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_wallet.Wallet.html">Wallet</a></section><section class="tsd-panel tsd-member"><a id="WalletAPIClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>WalletAPIClient</span><a href="#WalletAPIClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.WalletAPIClient.html">WalletAPIClient</a></section><section class="tsd-panel tsd-member"><a id="WalletAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Wallet<wbr/>Address</span><a href="#WalletAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/coinbase_address_wallet_address.WalletAddress.html">WalletAddress</a></section><section class="tsd-panel tsd-member"><a id="WalletCreateOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Wallet<wbr/>Create<wbr/>Options</span><a href="#WalletCreateOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.WalletCreateOptions.html">WalletCreateOptions</a></section><section class="tsd-panel tsd-member"><a id="WalletData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Wallet<wbr/>Data</span><a href="#WalletData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../types/coinbase_types.WalletData.html">WalletData</a></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#ATOMIC_UNITS_PER_USDC" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>ATOMIC_<wbr/>UNITS_<wbr/>PER_<wbr/>USDC</span></a><a href="#Address" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Address</span></a><a href="#AddressAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>AddressAPIClient</span></a><a href="#Amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Amount</span></a><a href="#ApiClients" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Api<wbr/>Clients</span></a><a href="#ArgumentError" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Argument<wbr/>Error</span></a><a href="#Asset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Asset</span></a><a href="#AssetAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>AssetAPIClient</span></a><a href="#Balance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Balance</span></a><a href="#BalanceMap" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Balance<wbr/>Map</span></a><a href="#Coinbase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Coinbase</span></a><a href="#CoinbaseConfigureFromJsonOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Coinbase<wbr/>Configure<wbr/>From<wbr/>Json<wbr/>Options</span></a><a href="#CoinbaseOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Coinbase<wbr/>Options</span></a><a href="#CreateTradeOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Create<wbr/>Trade<wbr/>Options</span></a><a href="#CreateTransferOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Create<wbr/>Transfer<wbr/>Options</span></a><a href="#Destination" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Destination</span></a><a href="#ExternalAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>External<wbr/>Address</span></a><a href="#ExternalAddressAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>External<wbr/>AddressAPIClient</span></a><a href="#FaucetTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Faucet<wbr/>Transaction</span></a><a href="#GWEI_DECIMALS" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>GWEI_<wbr/>DECIMALS</span></a><a href="#InternalError" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Internal<wbr/>Error</span></a><a href="#InvalidAPIKeyFormat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>InvalidAPIKey<wbr/>Format</span></a><a href="#InvalidConfiguration" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Invalid<wbr/>Configuration</span></a><a href="#InvalidUnsignedPayload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Invalid<wbr/>Unsigned<wbr/>Payload</span></a><a href="#SeedData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Seed<wbr/>Data</span></a><a href="#ServerSigner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Server<wbr/>Signer</span></a><a href="#ServerSignerAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Server<wbr/>SignerAPIClient</span></a><a href="#ServerSignerStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Server<wbr/>Signer<wbr/>Status</span></a><a href="#StakeAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>StakeAPIClient</span></a><a href="#StakeOptionsMode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Stake<wbr/>Options<wbr/>Mode</span></a><a href="#StakingOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Staking<wbr/>Operation</span></a><a href="#StakingReward" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Staking<wbr/>Reward</span></a><a href="#Trade" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Trade</span></a><a href="#TradeApiClients" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Trade<wbr/>Api<wbr/>Clients</span></a><a href="#Transaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Transaction</span></a><a href="#TransactionStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Transaction<wbr/>Status</span></a><a href="#Transfer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Transfer</span></a><a href="#TransferAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>TransferAPIClient</span></a><a href="#TransferStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Transfer<wbr/>Status</span></a><a href="#User" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>User</span></a><a href="#UserAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>UserAPIClient</span></a><a href="#Validator" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Validator</span></a><a href="#ValidatorAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>ValidatorAPIClient</span></a><a href="#WEI_PER_ETHER" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>WEI_<wbr/>PER_<wbr/>ETHER</span></a><a href="#Wallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Wallet</span></a><a href="#WalletAPIClient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>WalletAPIClient</span></a><a href="#WalletAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Wallet<wbr/>Address</span></a><a href="#WalletCreateOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Wallet<wbr/>Create<wbr/>Options</span></a><a href="#WalletData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Wallet<wbr/>Data</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/client_api.ServerSignerEventEvent.html b/docs/types/client_api.ServerSignerEventEvent.html index 7889236c..fe32725b 100644 --- a/docs/types/client_api.ServerSignerEventEvent.html +++ b/docs/types/client_api.ServerSignerEventEvent.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerSignerEventEvent | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ServerSignerEventEvent.html">ServerSignerEventEvent</a></li></ul><h1>Type alias ServerSignerEventEvent</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Server<wbr/>Signer<wbr/>Event<wbr/>Event</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.SeedCreationEvent.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEvent</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/client_api.SignatureCreationEvent.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEvent</a></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L734">src/client/api.ts:734</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerSignerEventEvent | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ServerSignerEventEvent.html">ServerSignerEventEvent</a></li></ul><h1>Type alias ServerSignerEventEvent</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Server<wbr/>Signer<wbr/>Event<wbr/>Event</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.SeedCreationEvent.html" class="tsd-signature-type tsd-kind-interface">SeedCreationEvent</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/client_api.SignatureCreationEvent.html" class="tsd-signature-type tsd-kind-interface">SignatureCreationEvent</a></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L734">src/client/api.ts:734</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/client_api.StakingContextContext.html b/docs/types/client_api.StakingContextContext.html index 4463dffd..0ac6b32f 100644 --- a/docs/types/client_api.StakingContextContext.html +++ b/docs/types/client_api.StakingContextContext.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingContextContext | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingContextContext.html">StakingContextContext</a></li></ul><h1>Type alias StakingContextContext</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Staking<wbr/>Context<wbr/>Context</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.NativeEthStakingContext.html" class="tsd-signature-type tsd-kind-interface">NativeEthStakingContext</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/client_api.PartialEthStakingContext.html" class="tsd-signature-type tsd-kind-interface">PartialEthStakingContext</a></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L942">src/client/api.ts:942</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingContextContext | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingContextContext.html">StakingContextContext</a></li></ul><h1>Type alias StakingContextContext</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Staking<wbr/>Context<wbr/>Context</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.NativeEthStakingContext.html" class="tsd-signature-type tsd-kind-interface">NativeEthStakingContext</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/client_api.PartialEthStakingContext.html" class="tsd-signature-type tsd-kind-interface">PartialEthStakingContext</a></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L942">src/client/api.ts:942</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/client_api.StakingOperationMetadata.html b/docs/types/client_api.StakingOperationMetadata.html index efb16d29..ca6f9d53 100644 --- a/docs/types/client_api.StakingOperationMetadata.html +++ b/docs/types/client_api.StakingOperationMetadata.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingOperationMetadata | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingOperationMetadata.html">StakingOperationMetadata</a></li></ul><h1>Type alias StakingOperationMetadata</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Staking<wbr/>Operation<wbr/>Metadata</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.SignedVoluntaryExitMessageMetadata.html" class="tsd-signature-type tsd-kind-interface">SignedVoluntaryExitMessageMetadata</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1001">src/client/api.ts:1001</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingOperationMetadata | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingOperationMetadata.html">StakingOperationMetadata</a></li></ul><h1>Type alias StakingOperationMetadata</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Staking<wbr/>Operation<wbr/>Metadata</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.SignedVoluntaryExitMessageMetadata.html" class="tsd-signature-type tsd-kind-interface">SignedVoluntaryExitMessageMetadata</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1001">src/client/api.ts:1001</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/client_api.StakingOperationStatusEnum.html b/docs/types/client_api.StakingOperationStatusEnum.html index 637efb51..4b486bcc 100644 --- a/docs/types/client_api.StakingOperationStatusEnum.html +++ b/docs/types/client_api.StakingOperationStatusEnum.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingOperationStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingOperationStatusEnum.html">StakingOperationStatusEnum</a></li></ul><h1>Type alias StakingOperationStatusEnum</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Staking<wbr/>Operation<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.StakingOperationStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">StakingOperationStatusEnum</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.StakingOperationStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">StakingOperationStatusEnum</a><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L988">src/client/api.ts:988</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L995">src/client/api.ts:995</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingOperationStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingOperationStatusEnum.html">StakingOperationStatusEnum</a></li></ul><h1>Type alias StakingOperationStatusEnum</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Staking<wbr/>Operation<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.StakingOperationStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">StakingOperationStatusEnum</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.StakingOperationStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">StakingOperationStatusEnum</a><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L988">src/client/api.ts:988</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L995">src/client/api.ts:995</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/client_api.StakingRewardStateEnum.html b/docs/types/client_api.StakingRewardStateEnum.html index bcfe01bd..4d16fea9 100644 --- a/docs/types/client_api.StakingRewardStateEnum.html +++ b/docs/types/client_api.StakingRewardStateEnum.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingRewardStateEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingRewardStateEnum.html">StakingRewardStateEnum</a></li></ul><h1>Type alias StakingRewardStateEnum</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Staking<wbr/>Reward<wbr/>State<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.StakingRewardStateEnum-1.html" class="tsd-signature-type tsd-kind-variable">StakingRewardStateEnum</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.StakingRewardStateEnum-1.html" class="tsd-signature-type tsd-kind-variable">StakingRewardStateEnum</a><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1041">src/client/api.ts:1041</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1046">src/client/api.ts:1046</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingRewardStateEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingRewardStateEnum.html">StakingRewardStateEnum</a></li></ul><h1>Type alias StakingRewardStateEnum</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Staking<wbr/>Reward<wbr/>State<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.StakingRewardStateEnum-1.html" class="tsd-signature-type tsd-kind-variable">StakingRewardStateEnum</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.StakingRewardStateEnum-1.html" class="tsd-signature-type tsd-kind-variable">StakingRewardStateEnum</a><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1041">src/client/api.ts:1041</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1046">src/client/api.ts:1046</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/client_api.TransactionStatusEnum.html b/docs/types/client_api.TransactionStatusEnum.html index 3e65c4c8..dade61c6 100644 --- a/docs/types/client_api.TransactionStatusEnum.html +++ b/docs/types/client_api.TransactionStatusEnum.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransactionStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransactionStatusEnum.html">TransactionStatusEnum</a></li></ul><h1>Type alias TransactionStatusEnum</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Transaction<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.TransactionStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">TransactionStatusEnum</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.TransactionStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">TransactionStatusEnum</a><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1210">src/client/api.ts:1210</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1218">src/client/api.ts:1218</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransactionStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransactionStatusEnum.html">TransactionStatusEnum</a></li></ul><h1>Type alias TransactionStatusEnum</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Transaction<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.TransactionStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">TransactionStatusEnum</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.TransactionStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">TransactionStatusEnum</a><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1210">src/client/api.ts:1210</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1218">src/client/api.ts:1218</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/client_api.TransferStatusEnum.html b/docs/types/client_api.TransferStatusEnum.html index 6627a7eb..7b716ea8 100644 --- a/docs/types/client_api.TransferStatusEnum.html +++ b/docs/types/client_api.TransferStatusEnum.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransferStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransferStatusEnum.html">TransferStatusEnum</a></li></ul><h1>Type alias TransferStatusEnum</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Transfer<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.TransferStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">TransferStatusEnum</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.TransferStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">TransferStatusEnum</a><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1319">src/client/api.ts:1319</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1326">src/client/api.ts:1326</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransferStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransferStatusEnum.html">TransferStatusEnum</a></li></ul><h1>Type alias TransferStatusEnum</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Transfer<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.TransferStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">TransferStatusEnum</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.TransferStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">TransferStatusEnum</a><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1319">src/client/api.ts:1319</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1326">src/client/api.ts:1326</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/client_api.ValidatorDetails.html b/docs/types/client_api.ValidatorDetails.html index bad911f3..232d2d4a 100644 --- a/docs/types/client_api.ValidatorDetails.html +++ b/docs/types/client_api.ValidatorDetails.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ValidatorDetails | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ValidatorDetails.html">ValidatorDetails</a></li></ul><h1>Type alias ValidatorDetails</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Validator<wbr/>Details</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.EthereumValidatorMetadata.html" class="tsd-signature-type tsd-kind-interface">EthereumValidatorMetadata</a></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1419">src/client/api.ts:1419</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ValidatorDetails | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.ValidatorDetails.html">ValidatorDetails</a></li></ul><h1>Type alias ValidatorDetails</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Validator<wbr/>Details</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client_api.EthereumValidatorMetadata.html" class="tsd-signature-type tsd-kind-interface">EthereumValidatorMetadata</a></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1419">src/client/api.ts:1419</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/client_api.WalletServerSignerStatusEnum.html b/docs/types/client_api.WalletServerSignerStatusEnum.html index b4d933d4..fdaec9fc 100644 --- a/docs/types/client_api.WalletServerSignerStatusEnum.html +++ b/docs/types/client_api.WalletServerSignerStatusEnum.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WalletServerSignerStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.WalletServerSignerStatusEnum.html">WalletServerSignerStatusEnum</a></li></ul><h1>Type alias WalletServerSignerStatusEnum</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Wallet<wbr/>Server<wbr/>Signer<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.WalletServerSignerStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">WalletServerSignerStatusEnum</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.WalletServerSignerStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">WalletServerSignerStatusEnum</a><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1484">src/client/api.ts:1484</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1489">src/client/api.ts:1489</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WalletServerSignerStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.WalletServerSignerStatusEnum.html">WalletServerSignerStatusEnum</a></li></ul><h1>Type alias WalletServerSignerStatusEnum</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Wallet<wbr/>Server<wbr/>Signer<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.WalletServerSignerStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">WalletServerSignerStatusEnum</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-keyword">typeof </span><a href="../variables/client_api.WalletServerSignerStatusEnum-1.html" class="tsd-signature-type tsd-kind-variable">WalletServerSignerStatusEnum</a><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1484">src/client/api.ts:1484</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1489">src/client/api.ts:1489</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.AddressAPIClient.html b/docs/types/coinbase_types.AddressAPIClient.html index bae0954a..6c15e2a5 100644 --- a/docs/types/coinbase_types.AddressAPIClient.html +++ b/docs/types/coinbase_types.AddressAPIClient.html @@ -4,32 +4,32 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">createAddressRequest</span>: <a href="../interfaces/client_api.CreateAddressRequest.html" class="tsd-signature-type tsd-kind-interface">CreateAddressRequest</a></span><div class="tsd-comment tsd-typography"><p>The address creation request.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Axios request options.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L292">src/coinbase/types.ts:292</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Address</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.getAddress.getAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><a href="#__type.getAddress.getAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address by onchain address.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L292">src/coinbase/types.ts:292</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Address</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.getAddress.getAddress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span><a href="#__type.getAddress.getAddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address by onchain address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Axios request options.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Address.html" class="tsd-signature-type tsd-kind-interface">Address</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L228">src/coinbase/types.ts:228</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.getAddressBalance.getAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><a href="#__type.getAddressBalance.getAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balance</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L228">src/coinbase/types.ts:228</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.getAddressBalance.getAddressBalance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Address<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span><a href="#__type.getAddressBalance.getAddressBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get address balance</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balance for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The symbol of the asset to fetch the balance for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Axios request options.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L260">src/coinbase/types.ts:260</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listAddressBalances.listAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#__type.listAddressBalances.listAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists address balances</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L260">src/coinbase/types.ts:260</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listAddressBalances.listAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#__type.listAddressBalances.listAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists address balances</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balances for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Do not include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L277">src/coinbase/types.ts:277</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Addresses</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listAddresses.listAddresses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Addresses</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span><a href="#__type.listAddresses.listAddresses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists addresses.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L277">src/coinbase/types.ts:277</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Addresses</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listAddresses.listAddresses-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Addresses</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span><a href="#__type.listAddresses.listAddresses-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists addresses.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the addresses belong to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The maximum number of addresses to return.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Do not include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressList.html" class="tsd-signature-type tsd-kind-interface">AddressList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L244">src/coinbase/types.ts:244</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.requestFaucetFunds.requestFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#__type.requestFaucetFunds.requestFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests faucet funds for the address.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L244">src/coinbase/types.ts:244</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.requestFaucetFunds.requestFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#__type.requestFaucetFunds.requestFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests faucet funds for the address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The wallet ID.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The address ID.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span></h4><p>The transaction hash.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L218">src/coinbase/types.ts:218</a></li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L209">src/coinbase/types.ts:209</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L218">src/coinbase/types.ts:218</a></li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L209">src/coinbase/types.ts:209</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.Amount.html b/docs/types/coinbase_types.Amount.html index 5d90a9e5..3022f394 100644 --- a/docs/types/coinbase_types.Amount.html +++ b/docs/types/coinbase_types.Amount.html @@ -1,2 +1,2 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Amount | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_types.html">coinbase/types</a></li><li><a href="coinbase_types.Amount.html">Amount</a></li></ul><h1>Type alias Amount</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Decimal</span></div><div class="tsd-comment tsd-typography"><p>Amount type definition.</p> -</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L613">src/coinbase/types.ts:613</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L613">src/coinbase/types.ts:613</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.ApiClients.html b/docs/types/coinbase_types.ApiClients.html index 96e9b55c..a8ef16f3 100644 --- a/docs/types/coinbase_types.ApiClients.html +++ b/docs/types/coinbase_types.ApiClients.html @@ -1,3 +1,3 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ApiClients | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_types.html">coinbase/types</a></li><li><a href="coinbase_types.ApiClients.html">ApiClients</a></li></ul><h1>Type alias ApiClients</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Api<wbr/>Clients</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">address</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.AddressAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">AddressAPIClient</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">asset</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.AssetAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">AssetAPIClient</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">externalAddress</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.ExternalAddressAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">ExternalAddressAPIClient</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">serverSigner</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.ServerSignerAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">ServerSignerAPIClient</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">stake</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.StakeAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">StakeAPIClient</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">trade</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.TradeApiClients.html" class="tsd-signature-type tsd-kind-type-alias">TradeApiClients</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">transfer</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.TransferAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">TransferAPIClient</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">user</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.UserAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">UserAPIClient</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">validator</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.ValidatorAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">ValidatorAPIClient</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">wallet</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.WalletAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">WalletAPIClient</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>API clients type definition for the Coinbase SDK. Represents the set of API clients available in the SDK.</p> -</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">address</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.AddressAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">AddressAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">asset</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.AssetAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">AssetAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">external<wbr/>Address</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.ExternalAddressAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">ExternalAddressAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">server<wbr/>Signer</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.ServerSignerAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">ServerSignerAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">stake</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.StakeAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">StakeAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">trade</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.TradeApiClients.html" class="tsd-signature-type tsd-kind-type-alias">TradeApiClients</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">transfer</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.TransferAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">TransferAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">user</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.UserAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">UserAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">validator</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.ValidatorAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">ValidatorAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">wallet</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.WalletAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">WalletAPIClient</a></h5></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L558">src/coinbase/types.ts:558</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">address</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.AddressAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">AddressAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">asset</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.AssetAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">AssetAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">external<wbr/>Address</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.ExternalAddressAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">ExternalAddressAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">server<wbr/>Signer</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.ServerSignerAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">ServerSignerAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">stake</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.StakeAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">StakeAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">trade</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.TradeApiClients.html" class="tsd-signature-type tsd-kind-type-alias">TradeApiClients</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">transfer</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.TransferAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">TransferAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">user</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.UserAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">UserAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">validator</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.ValidatorAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">ValidatorAPIClient</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">wallet</span><span class="tsd-signature-symbol">?: </span><a href="coinbase_types.WalletAPIClient.html" class="tsd-signature-type tsd-kind-type-alias">WalletAPIClient</a></h5></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L558">src/coinbase/types.ts:558</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.AssetAPIClient.html b/docs/types/coinbase_types.AssetAPIClient.html index 37a7a614..2b1fc86f 100644 --- a/docs/types/coinbase_types.AssetAPIClient.html +++ b/docs/types/coinbase_types.AssetAPIClient.html @@ -4,4 +4,4 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Asset.html" class="tsd-signature-type tsd-kind-interface">Asset</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Summary</h4><p>Get the asset for the specified asset ID.</p> <h4>Throws</h4><p>If the required parameter is not provided.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L46">src/coinbase/types.ts:46</a></li></ul></aside></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L36">src/coinbase/types.ts:36</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L46">src/coinbase/types.ts:46</a></li></ul></aside></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L36">src/coinbase/types.ts:36</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html b/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html index 127a5b69..3f3ecad3 100644 --- a/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html +++ b/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html @@ -3,4 +3,4 @@ </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">debugging</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If true, logs API requests and responses to the console.</p> </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">file<wbr/>Path</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The path to the JSON file containing the API key and private key.</p> </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">use<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to use a Server-Signer or not.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L670">src/coinbase/types.ts:670</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L670">src/coinbase/types.ts:670</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.CoinbaseOptions.html b/docs/types/coinbase_types.CoinbaseOptions.html index 23957845..f4c90bdc 100644 --- a/docs/types/coinbase_types.CoinbaseOptions.html +++ b/docs/types/coinbase_types.CoinbaseOptions.html @@ -4,4 +4,4 @@ </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">debugging</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If true, logs API requests and responses to the console.</p> </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">private<wbr/>Key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The private key associated with the API key.</p> </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">use<wbr/>Server<wbr/>Signer</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to use a Server-Signer or not.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L640">src/coinbase/types.ts:640</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L640">src/coinbase/types.ts:640</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.CreateTradeOptions.html b/docs/types/coinbase_types.CreateTradeOptions.html new file mode 100644 index 00000000..aa5ada43 --- /dev/null +++ b/docs/types/coinbase_types.CreateTradeOptions.html @@ -0,0 +1,2 @@ +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateTradeOptions | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_types.html">coinbase/types</a></li><li><a href="coinbase_types.CreateTradeOptions.html">CreateTradeOptions</a></li></ul><h1>Type alias CreateTradeOptions</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Create<wbr/>Trade<wbr/>Options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">: </span><a href="coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">fromAssetId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">intervalSeconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeoutSeconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">toAssetId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Options for creating a Trade.</p> +</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">: </span><a href="coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">from<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">interval<wbr/>Seconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout<wbr/>Seconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">to<wbr/>Asset<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L725">src/coinbase/types.ts:725</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.CreateTransferOptions.html b/docs/types/coinbase_types.CreateTransferOptions.html index 63696cf5..3b812d29 100644 --- a/docs/types/coinbase_types.CreateTransferOptions.html +++ b/docs/types/coinbase_types.CreateTransferOptions.html @@ -1,2 +1,2 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateTransferOptions | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_types.html">coinbase/types</a></li><li><a href="coinbase_types.CreateTransferOptions.html">CreateTransferOptions</a></li></ul><h1>Type alias CreateTransferOptions</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Create<wbr/>Transfer<wbr/>Options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">: </span><a href="coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">assetId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">destination</span><span class="tsd-signature-symbol">: </span><a href="coinbase_types.Destination.html" class="tsd-signature-type tsd-kind-type-alias">Destination</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">intervalSeconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeoutSeconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Options for creating a Transfer.</p> -</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">: </span><a href="coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">asset<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">destination</span><span class="tsd-signature-symbol">: </span><a href="coinbase_types.Destination.html" class="tsd-signature-type tsd-kind-type-alias">Destination</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">interval<wbr/>Seconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout<wbr/>Seconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L714">src/coinbase/types.ts:714</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">: </span><a href="coinbase_types.Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">asset<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">destination</span><span class="tsd-signature-symbol">: </span><a href="coinbase_types.Destination.html" class="tsd-signature-type tsd-kind-type-alias">Destination</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">interval<wbr/>Seconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout<wbr/>Seconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L714">src/coinbase/types.ts:714</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.Destination.html b/docs/types/coinbase_types.Destination.html index f8204c42..50f84f00 100644 --- a/docs/types/coinbase_types.Destination.html +++ b/docs/types/coinbase_types.Destination.html @@ -1,2 +1,2 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Destination | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_types.html">coinbase/types</a></li><li><a href="coinbase_types.Destination.html">Destination</a></li></ul><h1>Type alias Destination</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Destination</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/coinbase_address.Address.html" class="tsd-signature-type tsd-kind-class">Address</a><span class="tsd-signature-symbol"> | </span><a href="../classes/coinbase_wallet.Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a></div><div class="tsd-comment tsd-typography"><p>Destination type definition.</p> -</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L618">src/coinbase/types.ts:618</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L618">src/coinbase/types.ts:618</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.ExternalAddressAPIClient.html b/docs/types/coinbase_types.ExternalAddressAPIClient.html index 5b744099..309ab509 100644 --- a/docs/types/coinbase_types.ExternalAddressAPIClient.html +++ b/docs/types/coinbase_types.ExternalAddressAPIClient.html @@ -5,15 +5,15 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the asset to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L328">src/coinbase/types.ts:328</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listExternalAddressBalances.listExternalAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#__type.listExternalAddressBalances.listExternalAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List all of the balances of an external address</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L328">src/coinbase/types.ts:328</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listExternalAddressBalances.listExternalAddressBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>External<wbr/>Address<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#__type.listExternalAddressBalances.listExternalAddressBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List all of the balances of an external address</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to fetch the balance for</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L312">src/coinbase/types.ts:312</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.requestExternalFaucetFunds.requestExternalFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#__type.requestExternalFaucetFunds.requestExternalFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to external address.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L312">src/coinbase/types.ts:312</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.requestExternalFaucetFunds.requestExternalFaucetFunds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>External<wbr/>Faucet<wbr/>Funds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span><a href="#__type.requestExternalFaucetFunds.requestExternalFaucetFunds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request faucet funds to be sent to external address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The onchain address of the address that is being fetched.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FaucetTransaction.html" class="tsd-signature-type tsd-kind-interface">FaucetTransaction</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L343">src/coinbase/types.ts:343</a></li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L302">src/coinbase/types.ts:302</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L343">src/coinbase/types.ts:343</a></li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L302">src/coinbase/types.ts:302</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.SeedData.html b/docs/types/coinbase_types.SeedData.html index 4df66f6d..10bd1b49 100644 --- a/docs/types/coinbase_types.SeedData.html +++ b/docs/types/coinbase_types.SeedData.html @@ -1,2 +1,2 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SeedData | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_types.html">coinbase/types</a></li><li><a href="coinbase_types.SeedData.html">SeedData</a></li></ul><h1>Type alias SeedData</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Seed<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">authTag</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">encrypted</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">iv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">seed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The Seed Data type definition.</p> -</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">auth<wbr/>Tag</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">encrypted</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">iv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">seed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L603">src/coinbase/types.ts:603</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">auth<wbr/>Tag</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">encrypted</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">iv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">seed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L603">src/coinbase/types.ts:603</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.ServerSignerAPIClient.html b/docs/types/coinbase_types.ServerSignerAPIClient.html index b18f5203..75e1932f 100644 --- a/docs/types/coinbase_types.ServerSignerAPIClient.html +++ b/docs/types/coinbase_types.ServerSignerAPIClient.html @@ -7,4 +7,4 @@ <li>A promise resolving to the Server-Signer list.</li> </ul> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L547">src/coinbase/types.ts:547</a></li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L537">src/coinbase/types.ts:537</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L547">src/coinbase/types.ts:547</a></li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L537">src/coinbase/types.ts:537</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.StakeAPIClient.html b/docs/types/coinbase_types.StakeAPIClient.html index 40bb26c2..25c9c55e 100644 --- a/docs/types/coinbase_types.StakeAPIClient.html +++ b/docs/types/coinbase_types.StakeAPIClient.html @@ -2,19 +2,19 @@ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">buildStakingOperationRequest</span>: <a href="../interfaces/client_api.BuildStakingOperationRequest.html" class="tsd-signature-type tsd-kind-interface">BuildStakingOperationRequest</a></span><div class="tsd-comment tsd-typography"><p>The request to build a staking operation.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Axios request options.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L372">src/coinbase/types.ts:372</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.fetchStakingRewards.fetchStakingRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><a href="#__type.fetchStakingRewards.fetchStakingRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the staking rewards for an address.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L372">src/coinbase/types.ts:372</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.fetchStakingRewards.fetchStakingRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Staking<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span><a href="#__type.fetchStakingRewards.fetchStakingRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the staking rewards for an address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fetchStakingRewardsRequest</span>: <a href="../interfaces/client_api.FetchStakingRewardsRequest.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewardsRequest</a></span><div class="tsd-comment tsd-typography"><p>The request to get the staking rewards for an address.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The amount of records to return in a single call.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The batch of records for a given section in the response.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Axios request options.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L413">src/coinbase/types.ts:413</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.getExternalStakingOperation.getExternalStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationID</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#__type.getExternalStakingOperation.getExternalStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a staking operation.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.FetchStakingRewards200Response.html" class="tsd-signature-type tsd-kind-interface">FetchStakingRewards200Response</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L413">src/coinbase/types.ts:413</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.getExternalStakingOperation.getExternalStakingOperation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>External<wbr/>Staking<wbr/>Operation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">stakingOperationID</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span><a href="#__type.getExternalStakingOperation.getExternalStakingOperation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a staking operation.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the staking operation corresponds to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">stakingOperationID</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the staking operation to fetch.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Axios request options.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingOperation.html" class="tsd-signature-type tsd-kind-interface">StakingOperation</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L386">src/coinbase/types.ts:386</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.getStakingContext.getStakingContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><a href="#__type.getStakingContext.getStakingContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get staking context for an address.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L386">src/coinbase/types.ts:386</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.getStakingContext.getStakingContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Staking<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">getStakingContextRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span><a href="#__type.getStakingContext.getStakingContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get staking context for an address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">getStakingContextRequest</span>: <a href="../interfaces/client_api.GetStakingContextRequest.html" class="tsd-signature-type tsd-kind-interface">GetStakingContextRequest</a></span><div class="tsd-comment tsd-typography"><p>The request to get the staking context for an address.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Axios request options.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.StakingContext.html" class="tsd-signature-type tsd-kind-interface">StakingContext</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L400">src/coinbase/types.ts:400</a></li></ul></aside></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L364">src/coinbase/types.ts:364</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L400">src/coinbase/types.ts:400</a></li></ul></aside></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L364">src/coinbase/types.ts:364</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.TradeApiClients.html b/docs/types/coinbase_types.TradeApiClients.html index f360a58f..e7687573 100644 --- a/docs/types/coinbase_types.TradeApiClients.html +++ b/docs/types/coinbase_types.TradeApiClients.html @@ -5,23 +5,23 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">broadcastTradeRequest</span>: <a href="../interfaces/client_api.BroadcastTradeRequest.html" class="tsd-signature-type tsd-kind-interface">BroadcastTradeRequest</a></span><div class="tsd-comment tsd-typography"><p>The request body.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the required parameter is not provided.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L64">src/coinbase/types.ts:64</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Trade</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><a href="#__type.createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new trade.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L64">src/coinbase/types.ts:64</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Trade</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.createTrade.createTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTradeRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><a href="#__type.createTrade.createTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new trade.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the source address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to conduct the trade from.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">createTradeRequest</span>: <a href="../interfaces/client_api.CreateTradeRequest.html" class="tsd-signature-type tsd-kind-interface">CreateTradeRequest</a></span><div class="tsd-comment tsd-typography"><p>The request body.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the required parameter is not provided.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L81">src/coinbase/types.ts:81</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Trade</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.getTrade.getTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><a href="#__type.getTrade.getTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a trade by ID.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L81">src/coinbase/types.ts:81</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Trade</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.getTrade.getTrade-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Trade</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">tradeId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span><a href="#__type.getTrade.getTrade-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a trade by ID.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the trade belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">tradeId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the trade to fetch.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Trade.html" class="tsd-signature-type tsd-kind-interface">Trade</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the required parameter is not provided.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L97">src/coinbase/types.ts:97</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Trades</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listTrades.listTrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Trades</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span><a href="#__type.listTrades.listTrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List trades for an address.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L97">src/coinbase/types.ts:97</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Trades</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listTrades.listTrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Trades</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span><a href="#__type.listTrades.listTrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List trades for an address.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address to list trades for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TradeList.html" class="tsd-signature-type tsd-kind-interface">TradeList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the required parameter is not provided.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L114">src/coinbase/types.ts:114</a></li></ul></aside></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L53">src/coinbase/types.ts:53</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L114">src/coinbase/types.ts:114</a></li></ul></aside></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L53">src/coinbase/types.ts:53</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.TransferAPIClient.html b/docs/types/coinbase_types.TransferAPIClient.html index 50860499..424ab797 100644 --- a/docs/types/coinbase_types.TransferAPIClient.html +++ b/docs/types/coinbase_types.TransferAPIClient.html @@ -9,7 +9,7 @@ <li>A promise resolving to the Transfer model.</li> </ul> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L472">src/coinbase/types.ts:472</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Transfer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><a href="#__type.createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a Transfer.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L472">src/coinbase/types.ts:472</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">create<wbr/>Transfer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.createTransfer.createTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">createTransferRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><a href="#__type.createTransfer.createTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a Transfer.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the transfer belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">createTransferRequest</span>: <a href="../interfaces/client_api.CreateTransferRequest.html" class="tsd-signature-type tsd-kind-interface">CreateTransferRequest</a></span><div class="tsd-comment tsd-typography"><p>The request body.</p> @@ -18,7 +18,7 @@ <li>A promise resolving to the Transfer model.</li> </ul> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L490">src/coinbase/types.ts:490</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Transfer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.getTransfer.getTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><a href="#__type.getTransfer.getTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a Transfer.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L490">src/coinbase/types.ts:490</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">get<wbr/>Transfer</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.getTransfer.getTransfer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Transfer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">transferId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Transfer.html" class="tsd-signature-type tsd-kind-interface">Transfer</a><span class="tsd-signature-symbol">></span><a href="#__type.getTransfer.getTransfer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a Transfer.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the transfer belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">transferId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the transfer to retrieve.</p> @@ -27,7 +27,7 @@ <li>A promise resolving to the Transfer model.</li> </ul> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L507">src/coinbase/types.ts:507</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Transfers</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listTransfers.listTransfers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Transfers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span><a href="#__type.listTransfers.listTransfers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists Transfers.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L507">src/coinbase/types.ts:507</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Transfers</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listTransfers.listTransfers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Transfers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">addressId</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.TransferList.html" class="tsd-signature-type tsd-kind-interface">TransferList</a><span class="tsd-signature-symbol">></span><a href="#__type.listTransfers.listTransfers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists Transfers.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet the address belongs to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">addressId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the address the transfers belong to.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The maximum number of transfers to return.</p> @@ -37,4 +37,4 @@ <li>A promise resolving to the Transfer list.</li> </ul> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L525">src/coinbase/types.ts:525</a></li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L460">src/coinbase/types.ts:460</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L525">src/coinbase/types.ts:525</a></li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L460">src/coinbase/types.ts:460</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.UserAPIClient.html b/docs/types/coinbase_types.UserAPIClient.html index a266b169..de2fbe9d 100644 --- a/docs/types/coinbase_types.UserAPIClient.html +++ b/docs/types/coinbase_types.UserAPIClient.html @@ -5,4 +5,4 @@ <li>A promise resolvindg to the User model.</li> </ul> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L361">src/coinbase/types.ts:361</a></li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L353">src/coinbase/types.ts:353</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L361">src/coinbase/types.ts:361</a></li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L353">src/coinbase/types.ts:353</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.ValidatorAPIClient.html b/docs/types/coinbase_types.ValidatorAPIClient.html index 45fe97a2..a112f00a 100644 --- a/docs/types/coinbase_types.ValidatorAPIClient.html +++ b/docs/types/coinbase_types.ValidatorAPIClient.html @@ -3,11 +3,11 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the asset to fetch the validator for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique publicly identifiable id of the validator for which to fetch the data.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Axios request options.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L449">src/coinbase/types.ts:449</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Validators</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listValidators.listValidators-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Validators</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span><a href="#__type.listValidators.listValidators-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the validators for a given network and asset.</p> +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Validator.html" class="tsd-signature-type tsd-kind-interface">Validator</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L449">src/coinbase/types.ts:449</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Validators</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listValidators.listValidators-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Validators</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">networkId</span>, <span class="tsd-kind-parameter">assetId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span><a href="#__type.listValidators.listValidators-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the validators for a given network and asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">networkId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the blockchain network.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the asset to fetch the validator for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The status to filter by.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The amount of records to return in a single call.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The batch of records for a given section in the response.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Axios request options.</p> -</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L432">src/coinbase/types.ts:432</a></li></ul></aside></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L421">src/coinbase/types.ts:421</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.ValidatorList.html" class="tsd-signature-type tsd-kind-interface">ValidatorList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L432">src/coinbase/types.ts:432</a></li></ul></aside></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L421">src/coinbase/types.ts:421</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletAPIClient.html b/docs/types/coinbase_types.WalletAPIClient.html index eb6321f9..c9a60bdb 100644 --- a/docs/types/coinbase_types.WalletAPIClient.html +++ b/docs/types/coinbase_types.WalletAPIClient.html @@ -12,20 +12,20 @@ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.Balance.html" class="tsd-signature-type tsd-kind-interface">Balance</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the required parameter is not provided.</p> <h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L184">src/coinbase/types.ts:184</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listWalletBalances.listWalletBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#__type.listWalletBalances.listWalletBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the balances of all of the addresses in the wallet aggregated by asset.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L184">src/coinbase/types.ts:184</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listWalletBalances.listWalletBalances-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#__type.listWalletBalances.listWalletBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the balances of all of the addresses in the wallet aggregated by asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balances for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the required parameter is not provided.</p> <h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L157">src/coinbase/types.ts:157</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="__type.listWalletBalances.listWalletBalances-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#__type.listWalletBalances.listWalletBalances-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the balances of all of the addresses in the wallet aggregated by asset.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L157">src/coinbase/types.ts:157</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="__type.listWalletBalances.listWalletBalances-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallet<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">walletId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span><a href="#__type.listWalletBalances.listWalletBalances-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the balances of all of the addresses in the wallet aggregated by asset.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">walletId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the wallet to fetch the balances for.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.AddressBalanceList.html" class="tsd-signature-type tsd-kind-interface">AddressBalanceList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the required parameter is not provided.</p> <h4>Throws</h4><p>If the request fails.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L170">src/coinbase/types.ts:170</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Wallets</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><a href="#__type.listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List wallets belonging to the user.</p> +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L170">src/coinbase/types.ts:170</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">list<wbr/>Wallets</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.listWallets.listWallets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Wallets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span><a href="#__type.listWallets.listWallets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List wallets belonging to the user.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RawAxiosRequestConfig</span></span><div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/client_api.WalletList.html" class="tsd-signature-type tsd-kind-interface">WalletList</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If the request fails.</p> <h4>Throws</h4><p>If the required parameter is not provided.</p> -</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L199">src/coinbase/types.ts:199</a></li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L126">src/coinbase/types.ts:126</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L199">src/coinbase/types.ts:199</a></li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L126">src/coinbase/types.ts:126</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletCreateOptions.html b/docs/types/coinbase_types.WalletCreateOptions.html index 72b19e4d..850be87a 100644 --- a/docs/types/coinbase_types.WalletCreateOptions.html +++ b/docs/types/coinbase_types.WalletCreateOptions.html @@ -1,2 +1,2 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WalletCreateOptions | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_types.html">coinbase/types</a></li><li><a href="coinbase_types.WalletCreateOptions.html">WalletCreateOptions</a></li></ul><h1>Type alias WalletCreateOptions</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Wallet<wbr/>Create<wbr/>Options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">intervalSeconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">networkId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">timeoutSeconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Options for creating a Wallet.</p> -</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">interval<wbr/>Seconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">network<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout<wbr/>Seconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L631">src/coinbase/types.ts:631</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">interval<wbr/>Seconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">network<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">timeout<wbr/>Seconds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L631">src/coinbase/types.ts:631</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletData.html b/docs/types/coinbase_types.WalletData.html index 0c3319de..58d5c414 100644 --- a/docs/types/coinbase_types.WalletData.html +++ b/docs/types/coinbase_types.WalletData.html @@ -1,3 +1,3 @@ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WalletData | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_types.html">coinbase/types</a></li><li><a href="coinbase_types.WalletData.html">WalletData</a></li></ul><h1>Type alias WalletData</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Wallet<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">seed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">walletId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>The Wallet Data type definition. The data required to recreate a Wallet.</p> -</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">seed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">wallet<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/types.ts#L595">src/coinbase/types.ts:595</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">seed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">wallet<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/types.ts#L595">src/coinbase/types.ts:595</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/variables/client_api.StakingOperationStatusEnum-1.html b/docs/variables/client_api.StakingOperationStatusEnum-1.html index 971c04dd..16226562 100644 --- a/docs/variables/client_api.StakingOperationStatusEnum-1.html +++ b/docs/variables/client_api.StakingOperationStatusEnum-1.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingOperationStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingOperationStatusEnum-1.html">StakingOperationStatusEnum</a></li></ul><h1>Variable StakingOperationStatusEnum<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Staking<wbr/>Operation<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">Complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"complete"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Failed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"failed"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Initialized</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"initialized"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"complete"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Failed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"failed"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Initialized</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"initialized"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L988">src/client/api.ts:988</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L995">src/client/api.ts:995</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingOperationStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingOperationStatusEnum-1.html">StakingOperationStatusEnum</a></li></ul><h1>Variable StakingOperationStatusEnum<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Staking<wbr/>Operation<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">Complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"complete"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Failed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"failed"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Initialized</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"initialized"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"complete"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Failed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"failed"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Initialized</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"initialized"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L988">src/client/api.ts:988</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L995">src/client/api.ts:995</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/variables/client_api.StakingRewardStateEnum-1.html b/docs/variables/client_api.StakingRewardStateEnum-1.html index fa71041e..a5727f32 100644 --- a/docs/variables/client_api.StakingRewardStateEnum-1.html +++ b/docs/variables/client_api.StakingRewardStateEnum-1.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingRewardStateEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingRewardStateEnum-1.html">StakingRewardStateEnum</a></li></ul><h1>Variable StakingRewardStateEnum<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Staking<wbr/>Reward<wbr/>State<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">Distributed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"distributed"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Distributed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"distributed"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1041">src/client/api.ts:1041</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1046">src/client/api.ts:1046</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakingRewardStateEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.StakingRewardStateEnum-1.html">StakingRewardStateEnum</a></li></ul><h1>Variable StakingRewardStateEnum<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Staking<wbr/>Reward<wbr/>State<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">Distributed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"distributed"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Distributed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"distributed"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1041">src/client/api.ts:1041</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1046">src/client/api.ts:1046</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/variables/client_api.TransactionStatusEnum-1.html b/docs/variables/client_api.TransactionStatusEnum-1.html index 2b9f6259..cbaa5680 100644 --- a/docs/variables/client_api.TransactionStatusEnum-1.html +++ b/docs/variables/client_api.TransactionStatusEnum-1.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransactionStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransactionStatusEnum-1.html">TransactionStatusEnum</a></li></ul><h1>Variable TransactionStatusEnum<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Transaction<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">Broadcast</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"broadcast"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"complete"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Failed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"failed"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Signed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"signed"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Broadcast</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"broadcast"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"complete"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Failed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"failed"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Signed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"signed"</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1210">src/client/api.ts:1210</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1218">src/client/api.ts:1218</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransactionStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransactionStatusEnum-1.html">TransactionStatusEnum</a></li></ul><h1>Variable TransactionStatusEnum<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Transaction<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">Broadcast</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"broadcast"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"complete"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Failed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"failed"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Signed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"signed"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Broadcast</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"broadcast"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"complete"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Failed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"failed"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Signed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"signed"</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1210">src/client/api.ts:1210</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1218">src/client/api.ts:1218</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/variables/client_api.TransferStatusEnum-1.html b/docs/variables/client_api.TransferStatusEnum-1.html index b8dc812e..738702ba 100644 --- a/docs/variables/client_api.TransferStatusEnum-1.html +++ b/docs/variables/client_api.TransferStatusEnum-1.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransferStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransferStatusEnum-1.html">TransferStatusEnum</a></li></ul><h1>Variable TransferStatusEnum<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Transfer<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">Broadcast</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"broadcast"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"complete"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Failed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"failed"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Broadcast</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"broadcast"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"complete"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Failed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"failed"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1319">src/client/api.ts:1319</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1326">src/client/api.ts:1326</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TransferStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.TransferStatusEnum-1.html">TransferStatusEnum</a></li></ul><h1>Variable TransferStatusEnum<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Transfer<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">Broadcast</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"broadcast"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"complete"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Failed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"failed"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Broadcast</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"broadcast"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"complete"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Failed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"failed"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Pending</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending"</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1319">src/client/api.ts:1319</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1326">src/client/api.ts:1326</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/variables/client_api.WalletServerSignerStatusEnum-1.html b/docs/variables/client_api.WalletServerSignerStatusEnum-1.html index 0a22bebb..3642caed 100644 --- a/docs/variables/client_api.WalletServerSignerStatusEnum-1.html +++ b/docs/variables/client_api.WalletServerSignerStatusEnum-1.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WalletServerSignerStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.WalletServerSignerStatusEnum-1.html">WalletServerSignerStatusEnum</a></li></ul><h1>Variable WalletServerSignerStatusEnum<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Wallet<wbr/>Server<wbr/>Signer<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">ActiveSeed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"active_seed"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">PendingSeedCreation</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending_seed_creation"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Active<wbr/>Seed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"active_seed"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Pending<wbr/>Seed<wbr/>Creation</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending_seed_creation"</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1484">src/client/api.ts:1484</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/api.ts#L1489">src/client/api.ts:1489</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WalletServerSignerStatusEnum | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_api.html">client/api</a></li><li><a href="client_api.WalletServerSignerStatusEnum-1.html">WalletServerSignerStatusEnum</a></li></ul><h1>Variable WalletServerSignerStatusEnum<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Wallet<wbr/>Server<wbr/>Signer<wbr/>Status<wbr/>Enum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">ActiveSeed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"active_seed"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">PendingSeedCreation</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending_seed_creation"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Active<wbr/>Seed</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"active_seed"</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">Pending<wbr/>Seed<wbr/>Creation</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pending_seed_creation"</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1484">src/client/api.ts:1484</a></li><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/api.ts#L1489">src/client/api.ts:1489</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/variables/client_base.BASE_PATH.html b/docs/variables/client_base.BASE_PATH.html index 158287f9..b4316f04 100644 --- a/docs/variables/client_base.BASE_PATH.html +++ b/docs/variables/client_base.BASE_PATH.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BASE_PATH | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_base.html">client/base</a></li><li><a href="client_base.BASE_PATH.html">BASE_PATH</a></li></ul><h1>Variable BASE_PATH<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">BASE_<wbr/>PATH</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L22">src/client/base.ts:22</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BASE_PATH | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_base.html">client/base</a></li><li><a href="client_base.BASE_PATH.html">BASE_PATH</a></li></ul><h1>Variable BASE_PATH<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">BASE_<wbr/>PATH</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L22">src/client/base.ts:22</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/variables/client_base.COLLECTION_FORMATS.html b/docs/variables/client_base.COLLECTION_FORMATS.html index e2e77f4b..31b37d63 100644 --- a/docs/variables/client_base.COLLECTION_FORMATS.html +++ b/docs/variables/client_base.COLLECTION_FORMATS.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>COLLECTION_FORMATS | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_base.html">client/base</a></li><li><a href="client_base.COLLECTION_FORMATS.html">COLLECTION_FORMATS</a></li></ul><h1>Variable COLLECTION_FORMATS<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">COLLECTION_<wbr/>FORMATS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">csv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pipes</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">ssv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">tsv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">csv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">pipes</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">ssv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">tsv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L28">src/client/base.ts:28</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>COLLECTION_FORMATS | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_base.html">client/base</a></li><li><a href="client_base.COLLECTION_FORMATS.html">COLLECTION_FORMATS</a></li></ul><h1>Variable COLLECTION_FORMATS<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">COLLECTION_<wbr/>FORMATS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">csv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pipes</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">ssv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">tsv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">csv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">pipes</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">ssv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">tsv</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L28">src/client/base.ts:28</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/variables/client_base.operationServerMap.html b/docs/variables/client_base.operationServerMap.html index 8ca38f59..a96f4862 100644 --- a/docs/variables/client_base.operationServerMap.html +++ b/docs/variables/client_base.operationServerMap.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>operationServerMap | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_base.html">client/base</a></li><li><a href="client_base.operationServerMap.html">operationServerMap</a></li></ul><h1>Variable operationServerMap<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">operation<wbr/>Server<wbr/>Map</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ServerMap</span><span class="tsd-signature-symbol"> = {}</span></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/base.ts#L85">src/client/base.ts:85</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>operationServerMap | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_base.html">client/base</a></li><li><a href="client_base.operationServerMap.html">operationServerMap</a></li></ul><h1>Variable operationServerMap<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">operation<wbr/>Server<wbr/>Map</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ServerMap</span><span class="tsd-signature-symbol"> = {}</span></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/base.ts#L85">src/client/base.ts:85</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/variables/client_common.DUMMY_BASE_URL.html b/docs/variables/client_common.DUMMY_BASE_URL.html index 9b029a6b..525c1c9e 100644 --- a/docs/variables/client_common.DUMMY_BASE_URL.html +++ b/docs/variables/client_common.DUMMY_BASE_URL.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DUMMY_BASE_URL | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.DUMMY_BASE_URL.html">DUMMY_BASE_URL</a></li></ul><h1>Variable DUMMY_BASE_URL<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">DUMMY_<wbr/>BASE_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://example.com"</span><span class="tsd-signature-symbol"> = 'https://example.com'</span></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/client/common.ts#L25">src/client/common.ts:25</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DUMMY_BASE_URL | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/client_common.html">client/common</a></li><li><a href="client_common.DUMMY_BASE_URL.html">DUMMY_BASE_URL</a></li></ul><h1>Variable DUMMY_BASE_URL<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">DUMMY_<wbr/>BASE_<wbr/>URL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://example.com"</span><span class="tsd-signature-symbol"> = 'https://example.com'</span></div><div class="tsd-comment tsd-typography"><h4>Export</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/client/common.ts#L25">src/client/common.ts:25</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html b/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html index 3f7c1603..1fb355eb 100644 --- a/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html +++ b/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ATOMIC_UNITS_PER_USDC | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_constants.html">coinbase/constants</a></li><li><a href="coinbase_constants.ATOMIC_UNITS_PER_USDC.html">ATOMIC_UNITS_PER_USDC</a></li></ul><h1>Variable ATOMIC_UNITS_PER_USDC<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">ATOMIC_<wbr/>UNITS_<wbr/>PER_<wbr/>USDC</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/constants.ts#L5">src/coinbase/constants.ts:5</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ATOMIC_UNITS_PER_USDC | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_constants.html">coinbase/constants</a></li><li><a href="coinbase_constants.ATOMIC_UNITS_PER_USDC.html">ATOMIC_UNITS_PER_USDC</a></li></ul><h1>Variable ATOMIC_UNITS_PER_USDC<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">ATOMIC_<wbr/>UNITS_<wbr/>PER_<wbr/>USDC</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/constants.ts#L5">src/coinbase/constants.ts:5</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/variables/coinbase_constants.GWEI_DECIMALS.html b/docs/variables/coinbase_constants.GWEI_DECIMALS.html index 821d7455..08d00457 100644 --- a/docs/variables/coinbase_constants.GWEI_DECIMALS.html +++ b/docs/variables/coinbase_constants.GWEI_DECIMALS.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GWEI_DECIMALS | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_constants.html">coinbase/constants</a></li><li><a href="coinbase_constants.GWEI_DECIMALS.html">GWEI_DECIMALS</a></li></ul><h1>Variable GWEI_DECIMALS<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">GWEI_<wbr/>DECIMALS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">9</span><span class="tsd-signature-symbol"> = 9</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/constants.ts#L3">src/coinbase/constants.ts:3</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GWEI_DECIMALS | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_constants.html">coinbase/constants</a></li><li><a href="coinbase_constants.GWEI_DECIMALS.html">GWEI_DECIMALS</a></li></ul><h1>Variable GWEI_DECIMALS<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">GWEI_<wbr/>DECIMALS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">9</span><span class="tsd-signature-symbol"> = 9</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/constants.ts#L3">src/coinbase/constants.ts:3</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/docs/variables/coinbase_constants.WEI_PER_ETHER.html b/docs/variables/coinbase_constants.WEI_PER_ETHER.html index e8153db6..e5cfa6f7 100644 --- a/docs/variables/coinbase_constants.WEI_PER_ETHER.html +++ b/docs/variables/coinbase_constants.WEI_PER_ETHER.html @@ -1 +1 @@ -<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WEI_PER_ETHER | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_constants.html">coinbase/constants</a></li><li><a href="coinbase_constants.WEI_PER_ETHER.html">WEI_PER_ETHER</a></li></ul><h1>Variable WEI_PER_ETHER<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">WEI_<wbr/>PER_<wbr/>ETHER</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/0e6578f6c4392544048f021c6cbebc9a4da16b40/src/coinbase/constants.ts#L4">src/coinbase/constants.ts:4</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file +<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WEI_PER_ETHER | @coinbase/coinbase-sdk</title><meta name="description" content="Documentation for @coinbase/coinbase-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coinbase/coinbase-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coinbase/coinbase-sdk</a></li><li><a href="../modules/coinbase_constants.html">coinbase/constants</a></li><li><a href="coinbase_constants.WEI_PER_ETHER.html">WEI_PER_ETHER</a></li></ul><h1>Variable WEI_PER_ETHER<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature"><span class="tsd-kind-variable">WEI_<wbr/>PER_<wbr/>ETHER</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coinbase/coinbase-sdk-nodejs/blob/ff0de34e38b87ac4a21d065be11c6e79769b6b4d/src/coinbase/constants.ts#L4">src/coinbase/constants.ts:4</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@coinbase/coinbase-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> \ No newline at end of file diff --git a/package.json b/package.json index b34dc758..30675ad9 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "license": "ISC", "description": "Coinbase Platform SDK", "repository": "https://github.com/coinbase/coinbase-sdk-nodejs", - "version": "0.0.12", + "version": "0.0.13", "main": "dist/index.js", "types": "dist/index.d.ts", "scripts": { diff --git a/quickstart-template/trade_assets.js b/quickstart-template/trade_assets.js index 08d51c25..a9a5cae9 100644 --- a/quickstart-template/trade_assets.js +++ b/quickstart-template/trade_assets.js @@ -1,6 +1,6 @@ import { Coinbase } from "@coinbase/coinbase-sdk"; -let coinbase = Coinbase.configureFromJson({ filePath: '~/Downloads/cdp_api_key.json' }); +let coinbase = Coinbase.configureFromJson({ filePath: "~/Downloads/cdp_api_key.json" }); let user = await coinbase.getDefaultUser(); // Create a Wallet on base-mainnet to trade assets with. diff --git a/src/coinbase/address/wallet_address.ts b/src/coinbase/address/wallet_address.ts index f0f8b4c2..0b15441f 100644 --- a/src/coinbase/address/wallet_address.ts +++ b/src/coinbase/address/wallet_address.ts @@ -7,7 +7,14 @@ import { Coinbase } from "../coinbase"; import { ArgumentError, InternalError } from "../errors"; import { Trade } from "../trade"; import { Transfer } from "../transfer"; -import { Amount, CreateTransferOptions, Destination, TransferStatus } from "../types"; +import { + Amount, + CreateTransferOptions, + CreateTradeOptions, + Destination, + TransferStatus, + TransactionStatus, +} from "../types"; import { delay } from "../utils"; import { Wallet as WalletClass } from "../wallet"; @@ -67,9 +74,9 @@ export class WalletAddress extends Address { } /** - * Returns all the transfers associated with the address. + * Returns all the trades associated with the address. * - * @returns The list of transfers. + * @returns The list of trades. */ public async listTrades(): Promise<Trade[]> { const trades: Trade[] = []; @@ -84,8 +91,8 @@ export class WalletAddress extends Address { page?.length ? page : undefined, ); - response.data.data.forEach(transferModel => { - trades.push(new Trade(transferModel)); + response.data.data.forEach(tradeModel => { + trades.push(new Trade(tradeModel)); }); if (response.data.has_more) { @@ -244,25 +251,52 @@ export class WalletAddress extends Address { /** * Trades the given amount of the given Asset for another Asset. Only same-network Trades are supported. * - * @param amount - The amount of the Asset to send. - * @param fromAssetId - The ID of the Asset to trade from. - * @param toAssetId - The ID of the Asset to trade to. + * @param options = The options to create the Trade. + * @param options.amount - The amount of the From Asset to send. + * @param options.fromAssetId - The ID of the Asset to trade from. + * @param options.toAssetId - The ID of the Asset to trade to. + * @param options.timeoutSeconds - The maximum amount of time to wait for the Trade to complete, in seconds. + * @param options.intervalSeconds - The interval at which to poll the Network for Trade status, in seconds. * @returns The Trade object. - * @throws {Error} If the private key is not loaded, or if the asset IDs are unsupported, or if there are insufficient funds. + * @throws {APIError} if the API request to create or broadcast a Trade fails. + * @throws {Error} if the Trade times out. */ - public async createTrade(amount: Amount, fromAssetId: string, toAssetId: string): Promise<Trade> { + public async createTrade({ + amount, + fromAssetId, + toAssetId, + timeoutSeconds = 10, + intervalSeconds = 0.2, + }: CreateTradeOptions): Promise<Trade> { const fromAsset = await Asset.fetch(this.getNetworkId(), fromAssetId); const toAsset = await Asset.fetch(this.getNetworkId(), toAssetId); await this.validateCanTrade(amount, fromAssetId); - const trade = await this.createTradeRequest(amount, fromAsset, toAsset); - // NOTE: Trading does not yet support server signers at this point. - const signed_payload = await trade.getTransaction().sign(this.key!); - const approveTransactionSignedPayload = trade.getApproveTransaction() - ? await trade.getApproveTransaction()!.sign(this.key!) - : undefined; - - return this.broadcastTradeRequest(trade, signed_payload, approveTransactionSignedPayload); + let trade = await this.createTradeRequest(amount, fromAsset, toAsset); + + if (!Coinbase.useServerSigner) { + const signed_payload = await trade.getTransaction().sign(this.key!); + const approveTransactionSignedPayload = trade.getApproveTransaction() + ? await trade.getApproveTransaction()!.sign(this.key!) + : undefined; + + trade = await this.broadcastTradeRequest( + trade, + signed_payload, + approveTransactionSignedPayload, + ); + } + + const startTime = Date.now(); + while (Date.now() - startTime < timeoutSeconds * 1000) { + await trade.reload(); + const status = trade.getStatus(); + if (status === TransactionStatus.COMPLETE || status === TransactionStatus.FAILED) { + return trade; + } + await delay(intervalSeconds); + } + throw new Error("Trade timed out"); } /** @@ -329,7 +363,7 @@ export class WalletAddress extends Address { * @throws {Error} If the private key is not loaded, or if the asset IDs are unsupported, or if there are insufficient funds. */ private async validateCanTrade(amount: Amount, fromAssetId: string) { - if (!this.canSign()) { + if (!Coinbase.useServerSigner && !this.key) { throw new Error("Cannot trade from address without private key loaded"); } const currentBalance = await this.getBalance(fromAssetId); diff --git a/src/coinbase/types.ts b/src/coinbase/types.ts index 434e0f64..7762b60b 100644 --- a/src/coinbase/types.ts +++ b/src/coinbase/types.ts @@ -718,3 +718,14 @@ export type CreateTransferOptions = { timeoutSeconds?: number; intervalSeconds?: number; }; + +/** + * Options for creating a Trade. + */ +export type CreateTradeOptions = { + amount: Amount; + fromAssetId: string; + toAssetId: string; + timeoutSeconds?: number; + intervalSeconds?: number; +}; diff --git a/src/coinbase/wallet.ts b/src/coinbase/wallet.ts index 40e3bd1c..74f5b3e5 100644 --- a/src/coinbase/wallet.ts +++ b/src/coinbase/wallet.ts @@ -16,8 +16,8 @@ import { FaucetTransaction } from "./faucet_transaction"; import { Trade } from "./trade"; import { Transfer } from "./transfer"; import { - Amount, CreateTransferOptions, + CreateTradeOptions, SeedData, ServerSignerStatus, WalletCreateOptions, @@ -275,18 +275,33 @@ export class Wallet { /** * Trades the given amount of the given Asset for another Asset. Currently only the default address is used to source the Trade * - * @param amount - The amount of the Asset to send. - * @param fromAssetId - The ID of the Asset to trade from. - * @param toAssetId - The ID of the Asset to trade to. + * @param options - The options to create the Trade. + * @param options.amount - The amount of the Asset to send. + * @param options.fromAssetId - The ID of the Asset to trade from. + * @param options.toAssetId - The ID of the Asset to trade to. + * @param options.timeoutSeconds - The maximum amount of time to wait for the Trade to complete, in seconds. + * @param options.intervalSeconds - The interval at which to poll the Network for Trade status, in seconds. * @throws {InternalError} If the default address is not found. * @throws {Error} If the private key is not loaded, or if the asset IDs are unsupported, or if there are insufficient funds. * @returns The Trade object. */ - public async createTrade(amount: Amount, fromAssetId: string, toAssetId: string): Promise<Trade> { + public async createTrade({ + amount, + fromAssetId, + toAssetId, + timeoutSeconds = 10, + intervalSeconds = 0.2, + }: CreateTradeOptions): Promise<Trade> { if (!this.getDefaultAddress()) { throw new InternalError("Default address not found"); } - return await this.getDefaultAddress()!.createTrade(amount, fromAssetId, toAssetId); + return await this.getDefaultAddress()!.createTrade({ + amount: amount, + fromAssetId: fromAssetId, + toAssetId: toAssetId, + timeoutSeconds, + intervalSeconds, + }); } /** diff --git a/src/examples/trade_assets.js b/src/examples/trade_assets.js index 801207b4..1f183897 100644 --- a/src/examples/trade_assets.js +++ b/src/examples/trade_assets.js @@ -8,7 +8,11 @@ async function tradeAssets() { // Fund the wallet's default address with ETH from an external source. // Trade 0.00001 ETH to USDC - const trade = await wallet.createTrade(0.00001, Coinbase.assets.Eth, Coinbase.assets.Usdc); + const trade = await wallet.createTrade({ + amount: 0.00001, + fromAssetId: Coinbase.assets.Eth, + toAssetId: Coinbase.assets.Usdc, + }); console.log(`Trade successfully completed: `, trade.toString()); } diff --git a/src/tests/wallet_address_test.ts b/src/tests/wallet_address_test.ts index 1ee4b728..f22b0a24 100644 --- a/src/tests/wallet_address_test.ts +++ b/src/tests/wallet_address_test.ts @@ -304,28 +304,6 @@ describe("WalletAddress", () => { ).rejects.toThrow(InternalError); }); - it("it should successfully create and complete a transfer if using signer and key is not loaded", async () => { - Coinbase.apiClients.transfer!.createTransfer = mockReturnValue(VALID_TRANSFER_MODEL); - Coinbase.apiClients.transfer!.getTransfer = mockReturnValue({ - ...VALID_TRANSFER_MODEL, - status: TransferStatus.COMPLETE, - }); - - Coinbase.useServerSigner = true; - const addressWithoutKey = new WalletAddress(VALID_ADDRESS_MODEL, null!); - - await addressWithoutKey.createTransfer({ - amount: weiAmount, - assetId: Coinbase.assets.Wei, - destination, - timeoutSeconds, - intervalSeconds, - }); - - expect(Coinbase.apiClients.transfer!.createTransfer).toHaveBeenCalledTimes(1); - expect(Coinbase.apiClients.transfer!.getTransfer).toHaveBeenCalledTimes(1); - }); - it("should throw an ArgumentError if the Wallet Network ID does not match the Address Network ID", async () => { Coinbase.apiClients.wallet = walletsApiMock; Coinbase.apiClients.address = addressesApiMock; @@ -495,7 +473,7 @@ describe("WalletAddress", () => { }); }); - describe("#trade", () => { + describe("#createTrade", () => { let addressId; let toAddressId; let ethBalanceResponse; @@ -580,7 +558,7 @@ describe("WalletAddress", () => { balanceResponse = ethBalanceResponse; destination = toAddressId; amount = new Decimal(0.5); - useServerSigner = false; + Coinbase.useServerSigner = false; }); describe("when the trade is successful", () => { @@ -591,15 +569,23 @@ describe("WalletAddress", () => { Coinbase.apiClients.address!.getAddressBalance = mockReturnValue(balanceResponse); Coinbase.apiClients.trade!.createTrade = mockReturnValue(tradeModel); Coinbase.apiClients.asset.getAsset = getAssetMock(); + Coinbase.apiClients.trade!.broadcastTrade = mockReturnValue(broadcastedTradeModel); + Coinbase.apiClients.trade!.getTrade = mockReturnValue({ + ...broadcastedTradeModel, + transaction: { ...broadcastedTransactionModel, status: TransactionStatus.COMPLETE }, + }); jest.spyOn(Transaction.prototype, "sign").mockReturnValue(signedPayload); }); - it("should return the broadcasted trade", async () => { - Coinbase.apiClients.trade!.broadcastTrade = mockReturnValue(broadcastedTradeModel); - const result = await address.createTrade(amount, fromAssetId, toAssetId); + it("should return the completed trade", async () => { + const result = await address.createTrade({ + amount: amount, + fromAssetId: fromAssetId, + toAssetId: toAssetId, + }); const transaction = result.getTransaction(); expect(transaction.getSignedPayload()).toEqual(signedPayload); - expect(transaction.getStatus()).toEqual(TransactionStatus.BROADCAST); + expect(transaction.getStatus()).toEqual(TransactionStatus.COMPLETE); expect(transaction.getUnsignedPayload()).toEqual(unsignedPayload); expect(Coinbase.apiClients.trade!.createTrade).toHaveBeenCalledWith( address.getWalletId(), @@ -610,13 +596,20 @@ describe("WalletAddress", () => { to_asset_id: toAssetId, }, ); + expect(Coinbase.apiClients.trade!.broadcastTrade).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.trade!.getTrade).toHaveBeenCalledTimes(1); }); it("should sign the transaction with the key", async () => { - Coinbase.apiClients.trade!.broadcastTrade = mockReturnValue(broadcastedTradeModel); - const result = await address.createTrade(amount, fromAssetId, toAssetId); + const result = await address.createTrade({ + amount: amount, + fromAssetId: fromAssetId, + toAssetId: toAssetId, + }); const transaction = result.getTransaction(); expect(transaction.sign).toHaveBeenCalledWith(key); + expect(Coinbase.apiClients.trade!.broadcastTrade).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.trade!.getTrade).toHaveBeenCalledTimes(1); }); describe("when the asset is Gwei", () => { @@ -627,8 +620,11 @@ describe("WalletAddress", () => { }); it("should return the broadcast trade", async () => { - Coinbase.apiClients.trade!.broadcastTrade = mockReturnValue(broadcastedTradeModel); - await address.createTrade(amount, fromAssetId, toAssetId); + await address.createTrade({ + amount: amount, + fromAssetId: fromAssetId, + toAssetId: toAssetId, + }); expect(Coinbase.apiClients.trade!.createTrade).toHaveBeenCalledWith( address.getWalletId(), address.getId(), @@ -638,13 +634,20 @@ describe("WalletAddress", () => { to_asset_id: toAssetId, }, ); + expect(Coinbase.apiClients.trade!.broadcastTrade).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.trade!.getTrade).toHaveBeenCalledTimes(1); }); it("should sign the transaction with the address key", async () => { - Coinbase.apiClients.trade!.broadcastTrade = mockReturnValue(broadcastedTradeModel); - const result = await address.createTrade(amount, fromAssetId, toAssetId); + const result = await address.createTrade({ + amount: amount, + fromAssetId: fromAssetId, + toAssetId: toAssetId, + }); const transaction = result.getTransaction(); expect(transaction.sign).toHaveBeenCalledWith(key); + expect(Coinbase.apiClients.trade!.broadcastTrade).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.trade!.getTrade).toHaveBeenCalledTimes(1); }); }); @@ -656,8 +659,11 @@ describe("WalletAddress", () => { }); it("should return the broadcast trade", async () => { - Coinbase.apiClients.trade!.broadcastTrade = mockReturnValue(broadcastedTradeModel); - await address.createTrade(amount, fromAssetId, toAssetId); + await address.createTrade({ + amount: amount, + fromAssetId: fromAssetId, + toAssetId: toAssetId, + }); expect(Coinbase.apiClients.trade!.createTrade).toHaveBeenCalledWith( address.getWalletId(), address.getId(), @@ -667,13 +673,20 @@ describe("WalletAddress", () => { to_asset_id: toAssetId, }, ); + expect(Coinbase.apiClients.trade!.broadcastTrade).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.trade!.getTrade).toHaveBeenCalledTimes(1); }); it("should sign the transaction with the address key", async () => { - Coinbase.apiClients.trade!.broadcastTrade = mockReturnValue(broadcastedTradeModel); - const result = await address.createTrade(amount, fromAssetId, toAssetId); + const result = await address.createTrade({ + amount: amount, + fromAssetId: fromAssetId, + toAssetId: toAssetId, + }); const transaction = result.getTransaction(); expect(transaction.sign).toHaveBeenCalledWith(key); + expect(Coinbase.apiClients.trade!.broadcastTrade).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.trade!.getTrade).toHaveBeenCalledTimes(1); }); }); @@ -688,8 +701,11 @@ describe("WalletAddress", () => { }); it("should return the broadcast trade", async () => { - Coinbase.apiClients.trade!.broadcastTrade = mockReturnValue(broadcastedTradeModel); - await address.createTrade(amount, fromAssetId, toAssetId); + await address.createTrade({ + amount: amount, + fromAssetId: fromAssetId, + toAssetId: toAssetId, + }); expect(Coinbase.apiClients.trade!.createTrade).toHaveBeenCalledWith( address.getWalletId(), address.getId(), @@ -699,13 +715,20 @@ describe("WalletAddress", () => { to_asset_id: toAssetId, }, ); + expect(Coinbase.apiClients.trade!.broadcastTrade).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.trade!.getTrade).toHaveBeenCalledTimes(1); }); it("should sign the transaction with the address key", async () => { - Coinbase.apiClients.trade!.broadcastTrade = mockReturnValue(broadcastedTradeModel); - const result = await address.createTrade(amount, fromAssetId, toAssetId); + const result = await address.createTrade({ + amount: amount, + fromAssetId: fromAssetId, + toAssetId: toAssetId, + }); const transaction = result.getTransaction(); expect(transaction.sign).toHaveBeenCalledWith(key); + expect(Coinbase.apiClients.trade!.broadcastTrade).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.trade!.getTrade).toHaveBeenCalledTimes(1); }); }); @@ -722,31 +745,73 @@ describe("WalletAddress", () => { }); it("should sign the trade transaction with the address key", async () => { - const trade = await address.createTrade(amount, fromAssetId, toAssetId); + const trade = await address.createTrade({ + amount: amount, + fromAssetId: fromAssetId, + toAssetId: toAssetId, + }); const transaction = trade.getTransaction(); expect(transaction.sign).toHaveBeenCalledWith(key); + expect(Coinbase.apiClients.trade!.broadcastTrade).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.trade!.getTrade).toHaveBeenCalledTimes(1); + }); + }); + }); + + describe("when using server signer", () => { + beforeEach(() => { + jest.clearAllMocks(); + Coinbase.apiClients.asset = assetsApiMock; + Coinbase.apiClients.trade = tradeApiMock; + Coinbase.apiClients.address!.getAddressBalance = mockReturnValue(balanceResponse); + Coinbase.apiClients.trade!.createTrade = mockReturnValue(tradeModel); + Coinbase.apiClients.asset.getAsset = getAssetMock(); + Coinbase.useServerSigner = true; + }); + + it("should successfully create and complete a trade", async () => { + Coinbase.apiClients.trade!.getTrade = mockReturnValue({ + ...broadcastedTradeModel, + transaction: { ...broadcastedTransactionModel, status: TransactionStatus.COMPLETE }, + }); + + await address.createTrade({ + amount: amount, + fromAssetId: fromAssetId, + toAssetId: toAssetId, }); + + expect(Coinbase.apiClients.trade!.createTrade).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.trade!.getTrade).toHaveBeenCalledTimes(1); }); }); describe("when the address cannot sign", () => { it("should raise an Error", async () => { const newAddress = new WalletAddress(VALID_ADDRESS_MODEL, null!); - await expect(newAddress.createTrade(new Decimal(100), "eth", "usdc")).rejects.toThrow( - Error, - ); + await expect( + newAddress.createTrade({ + amount: new Decimal(100), + fromAssetId: "eth", + toAssetId: "usdc", + }), + ).rejects.toThrow(Error); }); }); describe("when the to fromAssetId is unsupported", () => { it("should raise an ArgumentError", async () => { - await expect(address.createTrade(new Decimal(100), "XYZ", "eth")).rejects.toThrow(Error); + await expect( + address.createTrade({ amount: new Decimal(100), fromAssetId: "XYZ", toAssetId: "eth" }), + ).rejects.toThrow(Error); }); }); describe("when the to toAssetId is unsupported", () => { it("should raise an ArgumentError", async () => { - await expect(address.createTrade(new Decimal(100), "eth", "XYZ")).rejects.toThrow(Error); + await expect( + address.createTrade({ amount: new Decimal(100), fromAssetId: "eth", toAssetId: "XYZ" }), + ).rejects.toThrow(Error); }); }); @@ -756,7 +821,9 @@ describe("WalletAddress", () => { Coinbase.apiClients.address!.getAddressBalance = mockReturnValue({ amount: "0" }); }); it("should raise an Error", async () => { - await expect(address.createTrade(new Decimal(100), "eth", "usdc")).rejects.toThrow(Error); + await expect( + address.createTrade({ amount: new Decimal(100), fromAssetId: "eth", toAssetId: "usdc" }), + ).rejects.toThrow(Error); }); }); diff --git a/src/tests/wallet_test.ts b/src/tests/wallet_test.ts index fc2be92b..d793f569 100644 --- a/src/tests/wallet_test.ts +++ b/src/tests/wallet_test.ts @@ -812,7 +812,7 @@ describe("Wallet Class", () => { }); }); - describe("#trade", () => { + describe("#createTrade", () => { const tradeObject = new Trade({ network_id: Coinbase.networks.BaseSepolia, wallet_id: walletId, @@ -829,16 +829,21 @@ describe("Wallet Class", () => { it("should throw an error when the wallet does not have a default address", async () => { const newWallet = Wallet.init(walletModel); - await expect(async () => await newWallet.createTrade(0.01, "eth", "usdc")).rejects.toThrow( - InternalError, - ); + await expect( + async () => + await newWallet.createTrade({ amount: 0.01, fromAssetId: "eth", toAssetId: "usdc" }), + ).rejects.toThrow(InternalError); }); it("should create a trade from the default address", async () => { const trade = Promise.resolve(tradeObject); jest.spyOn(Wallet.prototype, "createTrade").mockReturnValue(trade); const wallet = await Wallet.create(); - const result = await wallet.createTrade(0.01, "eth", "usdc"); + const result = await wallet.createTrade({ + amount: 0.01, + fromAssetId: "eth", + toAssetId: "usdc", + }); expect(result).toBeInstanceOf(Trade); expect(result.getAddressId()).toBe(tradeObject.getAddressId()); expect(result.getWalletId()).toBe(tradeObject.getWalletId()); diff --git a/tsconfig.json b/tsconfig.json index cd1abaa1..ad75a218 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -11,7 +11,7 @@ "forceConsistentCasingInFileNames": true, "declaration": true, "noImplicitAny": false, - "removeComments": true + "removeComments": false }, "include": ["src/**/*.ts"], "exclude": ["node_modules", "dist", "**/__tests__/**/**"]