Go API client for multibaas

MultiBaas's REST APIv0.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: 0.0
Package version: 1.0.0-beta6
Generator version: 7.6.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import multibaas "github.com/curvegrid/multibaas-sdk-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value multibaas.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), multibaas.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value multibaas.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), multibaas.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using multibaas.ContextOperationServerIndices and multibaas.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), multibaas.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), multibaas.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://your_deployment.multibaas.com/api/v0

Class	Method	HTTP request	Description
AddressesAPI	DeleteAddress	Delete /chains/{chain}/addresses/{address-or-label}	Delete address
AddressesAPI	GetAddress	Get /chains/{chain}/addresses/{address-or-label}	Get address
AddressesAPI	ListAddresses	Get /chains/{chain}/addresses	List addresses
AddressesAPI	SetAddress	Post /chains/{chain}/addresses	Create or update address
AdminAPI	AcceptInvite	Post /invites/{inviteID}	Accept invite
AdminAPI	AddCorsOrigin	Post /cors	Add CORS origin
AdminAPI	AddGroupApiKey	Put /groups/{groupID}/api_keys/{apiKeyID}	Add API key to group
AdminAPI	AddGroupRole	Put /groups/{groupID}/roles/{roleShortName}	Add role to group
AdminAPI	AddGroupUser	Put /groups/{groupID}/users/{userID}	Add user to group
AdminAPI	CheckInvite	Get /invites/{inviteID}	Check invite
AdminAPI	CreateApiKey	Post /api_keys	Create API key
AdminAPI	DeleteApiKey	Delete /api_keys/{apiKeyID}	Delete API key
AdminAPI	DeleteUser	Delete /users/{userID}	Delete user
AdminAPI	GetApiKey	Get /api_keys/{apiKeyID}	Get API Key
AdminAPI	InviteUser	Post /invites	Invite user
AdminAPI	ListApiKeys	Get /api_keys	List API keys
AdminAPI	ListAuditLogs	Get /systemactivities	List audit logs
AdminAPI	ListCorsOrigins	Get /cors	List CORS origins
AdminAPI	ListGroups	Get /groups	List groups
AdminAPI	ListUserSigners	Get /users/{userID}/signers	List user signers
AdminAPI	ListUsers	Get /users	List users
AdminAPI	RemoveCorsOrigin	Delete /cors/{originID}	Remove CORS Origin
AdminAPI	RemoveGroupApiKey	Delete /groups/{groupID}/api_keys/{apiKeyID}	Remove API key from group
AdminAPI	RemoveGroupRole	Delete /groups/{groupID}/roles/{roleShortName}	Remove role from group
AdminAPI	RemoveGroupUser	Delete /groups/{groupID}/users/{userID}	Remove user from group
AdminAPI	RemoveUserSignerCloudWallet	Delete /users/{userID}/cloudwallets/{wallet_address}	Remove user cloud wallet signer
AdminAPI	RemoveUserSignerWeb3Wallet	Delete /users/{userID}/web3wallets/{wallet_address}	Remove user web3 wallet signer
AdminAPI	SetUserSignerCloudWallet	Put /users/{userID}/cloudwallets/{wallet_address}	Add or update user cloud wallet signer
AdminAPI	SetUserSignerWeb3Wallet	Put /users/{userID}/web3wallets/{wallet_address}	Add or update user web3 wallet signer
AdminAPI	UpdateApiKey	Put /api_keys/{apiKeyID}	Update API key
ChainsAPI	GetBlock	Get /chains/{chain}/blocks/{block}	Get a block
ChainsAPI	GetChainStatus	Get /chains/{chain}/status	Get chain status
ChainsAPI	GetTransaction	Get /chains/{chain}/transactions/{hash}	Get transaction
ChainsAPI	GetTransactionReceipt	Get /chains/{chain}/transactions/receipt/{hash}	Get transaction receipt
ChainsAPI	SubmitSignedTransaction	Post /chains/{chain}/transactions/submit	Submit signed transaction
ChainsAPI	TransferEth	Post /chains/{chain}/transfers	Transfer ETH
ContractsAPI	CallContractFunction	Post /chains/{chain}/addresses/{address-or-label}/contracts/{contract}/methods/{method}	Call a contract function
ContractsAPI	CreateContract	Post /contracts/{contract}	Create a contract
ContractsAPI	CreateContracts	Post /contracts	Create multiple contracts
ContractsAPI	DeleteContract	Delete /contracts/{contract}	Delete a contract
ContractsAPI	DeleteContractVersion	Delete /contracts/{contract}/{version}	Delete a contract version
ContractsAPI	DeployContract	Post /contracts/{contract}/deploy	Deploy a contract
ContractsAPI	DeployContractVersion	Post /contracts/{contract}/{version}/deploy	Deploy a contract version
ContractsAPI	GetContract	Get /contracts/{contract}	Get a contract
ContractsAPI	GetContractVersion	Get /contracts/{contract}/{version}	Get a contract version
ContractsAPI	GetContractVersions	Get /contracts/{contract}/all	Get all contract versions
ContractsAPI	GetEventMonitorStatus	Get /chains/{chain}/addresses/{address-or-label}/contracts/{contract}/status	Get event monitor status
ContractsAPI	GetEventTypeConversions	Get /contracts/{contract}/{version}/events/{event}	Get event type conversions
ContractsAPI	GetFunctionTypeConversions	Get /contracts/{contract}/{version}/methods/{method}	Get function type conversions
ContractsAPI	LinkAddressContract	Post /chains/{chain}/addresses/{address-or-label}/contracts	Link address and contract
ContractsAPI	ListContractVersions	Get /contracts/{contract}/versions	List all contract versions
ContractsAPI	ListContracts	Get /contracts	List contracts
ContractsAPI	SetEventTypeConversions	Post /contracts/{contract}/{version}/events/{event}	Set event type conversions
ContractsAPI	SetFunctionTypeConversions	Post /contracts/{contract}/{version}/methods/{method}	Set function type conversions
ContractsAPI	UnlinkAddressContract	Delete /chains/{chain}/addresses/{address-or-label}/contracts/{contract}	Unlink address and contract
EventQueriesAPI	CountEventQueryRecords	Get /queries/{event_query}/count	Count event query records
EventQueriesAPI	DeleteEventQuery	Delete /queries/{event_query}	Delete event query
EventQueriesAPI	ExecuteArbitraryEventQuery	Post /queries	Execute arbitrary event query
EventQueriesAPI	ExecuteEventQuery	Get /queries/{event_query}/results	Execute event query
EventQueriesAPI	GetEventQuery	Get /queries/{event_query}	Get event query
EventQueriesAPI	ListEventQueries	Get /queries	List event queries
EventQueriesAPI	SetEventQuery	Put /queries/{event_query}	Create or update event query
EventsAPI	GetEventCount	Get /events/count	Get event count
EventsAPI	ListEvents	Get /events	List events
HsmAPI	AddHsmConfig	Post /hsm/config	Add HSM config
HsmAPI	AddHsmKey	Post /hsm/key	Add HSM key
HsmAPI	CreateHsmKey	Post /hsm/key/new	Create HSM key
HsmAPI	ListHsm	Get /hsm	List HSM configs and wallets
HsmAPI	ListHsmWallets	Get /hsm/wallets	List HSM wallets
HsmAPI	RemoveHsmConfig	Delete /hsm/config/{client_id}	Remove HSM config
HsmAPI	RemoveHsmKey	Delete /hsm/key/{wallet_address}	Remove HSM key
HsmAPI	SetLocalNonce	Post /chains/{chain}/hsm/nonce/{wallet_address}	Set local nonce
HsmAPI	SignAndSubmitTransaction	Post /chains/{chain}/hsm/submit	Sign and submit transaction
HsmAPI	SignData	Post /chains/{chain}/hsm/sign	Sign data
TxmAPI	CancelTransaction	Post /chains/{chain}/txm/{wallet_address}/nonce/{nonce}/cancel	Cancel transaction
TxmAPI	CountWalletTransactions	Get /chains/{chain}/txm/{wallet_address}/count	Count all transactions for a wallet
TxmAPI	ListWalletTransactions	Get /chains/{chain}/txm/{wallet_address}	List transactions for a wallet
TxmAPI	SpeedUpTransaction	Post /chains/{chain}/txm/{wallet_address}/nonce/{nonce}/speed_up	Speed up transaction
WebhooksAPI	CountWebhookEvents	Get /webhooks/{webhookID}/events/count	Count webhook events
WebhooksAPI	CountWebhooks	Get /webhooks/count	Count webhooks
WebhooksAPI	CreateWebhook	Post /webhooks	Create webhook
WebhooksAPI	DeleteWebhook	Delete /webhooks/{webhookID}	Delete webhook
WebhooksAPI	GetWebhook	Get /webhooks/{webhookID}	Get webhook
WebhooksAPI	ListWebhookEvents	Get /webhooks/{webhookID}/events	List webhook events
WebhooksAPI	ListWebhooks	Get /webhooks	List webhooks
WebhooksAPI	UpdateWebhook	Put /webhooks/{webhookID}	Update webhook

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer

Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), multibaas.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

cookie

Type: API key
API key parameter name: token
Location:

Note, each API key must be added to a map of map[string]APIKey where the key is: token and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		multibaas.ContextAPIKeys,
		map[string]multibaas.APIKey{
			"token": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

Name		Name	Last commit message	Last commit date
Latest commit History 8 Commits
.github/workflows		.github/workflows
.openapi-generator		.openapi-generator
api		api
docs		docs
example		example
.gitignore		.gitignore
.openapi-generator-ignore		.openapi-generator-ignore
LICENSE		LICENSE
README.md		README.md
api_addresses.go		api_addresses.go
api_admin.go		api_admin.go
api_chains.go		api_chains.go
api_contracts.go		api_contracts.go
api_event_queries.go		api_event_queries.go
api_events.go		api_events.go
api_hsm.go		api_hsm.go
api_txm.go		api_txm.go
api_webhooks.go		api_webhooks.go
client.go		client.go
configuration.go		configuration.go
errors.go		errors.go
generate.sh		generate.sh
go.mod		go.mod
go.sum		go.sum
go.work		go.work
model_accept_invite_200_response.go		model_accept_invite_200_response.go
model_accept_invite_request.go		model_accept_invite_request.go
model_add_key.go		model_add_key.go
model_address.go		model_address.go
model_address_label.go		model_address_label.go
model_api_key.go		model_api_key.go
model_api_key_with_secret.go		model_api_key_with_secret.go
model_audit_log.go		model_audit_log.go
model_azure_account.go		model_azure_account.go
model_azure_hardware_wallet.go		model_azure_hardware_wallet.go
model_azure_wallet.go		model_azure_wallet.go
model_base_api_key.go		model_base_api_key.go
model_base_azure_account.go		model_base_azure_account.go
model_base_contract.go		model_base_contract.go
model_base_response.go		model_base_response.go
model_base_transaction_to_sign.go		model_base_transaction_to_sign.go
model_base_transaction_to_sign_tx.go		model_base_transaction_to_sign_tx.go
model_base_user.go		model_base_user.go
model_base_webhook_endpoint.go		model_base_webhook_endpoint.go
model_block.go		model_block.go
model_call_contract_function_200_response.go		model_call_contract_function_200_response.go
model_call_contract_function_200_response_all_of_result.go		model_call_contract_function_200_response_all_of_result.go
model_chain_name.go		model_chain_name.go
model_chain_status.go		model_chain_status.go
model_contract.go		model_contract.go
model_contract_abi.go		model_contract_abi.go
model_contract_abi_error.go		model_contract_abi_error.go
model_contract_abi_error_argument.go		model_contract_abi_error_argument.go
model_contract_abi_event.go		model_contract_abi_event.go
model_contract_abi_event_argument.go		model_contract_abi_event_argument.go
model_contract_abi_method.go		model_contract_abi_method.go
model_contract_abi_method_1.go		model_contract_abi_method_1.go
model_contract_abi_method_argument.go		model_contract_abi_method_argument.go
model_contract_abi_type.go		model_contract_abi_type.go
model_contract_abi_type_conversion.go		model_contract_abi_type_conversion.go
model_contract_event_options.go		model_contract_event_options.go
model_contract_information.go		model_contract_information.go
model_contract_instance.go		model_contract_instance.go
model_contract_metadata.go		model_contract_metadata.go
model_contract_method_information.go		model_contract_method_information.go
model_contract_method_options.go		model_contract_method_options.go
model_contract_overview.go		model_contract_overview.go
model_contract_parameter.go		model_contract_parameter.go
model_cors_origin.go		model_cors_origin.go
model_count_event_query_records_200_response.go		model_count_event_query_records_200_response.go
model_count_wallet_transactions_200_response.go		model_count_wallet_transactions_200_response.go
model_count_webhook_events_200_response.go		model_count_webhook_events_200_response.go
model_count_webhooks_200_response.go		model_count_webhooks_200_response.go
model_create_api_key_200_response.go		model_create_api_key_200_response.go
model_create_api_key_request.go		model_create_api_key_request.go
model_create_hsm_key_200_response.go		model_create_hsm_key_200_response.go
model_create_key.go		model_create_key.go
model_create_webhook_200_response.go		model_create_webhook_200_response.go
model_deploy_contract_200_response.go		model_deploy_contract_200_response.go
model_deploy_contract_transaction.go		model_deploy_contract_transaction.go
model_error.go		model_error.go
model_event.go		model_event.go
model_event_field.go		model_event_field.go
model_event_information.go		model_event_information.go
model_event_monitor_status.go		model_event_monitor_status.go
model_event_query.go		model_event_query.go
model_event_query_event.go		model_event_query_event.go
model_event_query_field.go		model_event_query_field.go
model_event_query_filter.go		model_event_query_filter.go
model_event_query_results.go		model_event_query_results.go
model_event_type_conversion_options.go		model_event_type_conversion_options.go
model_execute_arbitrary_event_query_200_response.go		model_execute_arbitrary_event_query_200_response.go
model_field_type.go		model_field_type.go
model_gas_params.go		model_gas_params.go
model_get_api_key_200_response.go		model_get_api_key_200_response.go
model_get_block_200_response.go		model_get_block_200_response.go
model_get_chain_status_200_response.go		model_get_chain_status_200_response.go
model_get_contract_200_response.go		model_get_contract_200_response.go
model_get_contract_versions_200_response.go		model_get_contract_versions_200_response.go
model_get_event_count_200_response.go		model_get_event_count_200_response.go

License

curvegrid/multibaas-sdk-go

Folders and files

Latest commit

History