client

package
v0.0.11 Latest Latest
Warning

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

 Go to latest Published: Apr 1, 2026 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package client provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.6.0 DO NOT EDIT.

Index

Constants

View Source 
const (
	BearerAuthScopes = "bearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewCreateOnrampRequest added in v0.0.10 

func NewCreateOnrampRequest(server string, params *CreateOnrampParams, body CreateOnrampJSONRequestBody) (*http.Request, error)

NewCreateOnrampRequest calls the generic CreateOnramp builder with application/json body

func NewCreateOnrampRequestWithBody added in v0.0.10 

func NewCreateOnrampRequestWithBody(server string, params *CreateOnrampParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateOnrampRequestWithBody generates requests for CreateOnramp with any type of body

func NewCreateQuoteRequest 

func NewCreateQuoteRequest(server string, params *CreateQuoteParams, body CreateQuoteJSONRequestBody) (*http.Request, error)

NewCreateQuoteRequest calls the generic CreateQuote builder with application/json body

func NewCreateQuoteRequestWithBody 

func NewCreateQuoteRequestWithBody(server string, params *CreateQuoteParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateQuoteRequestWithBody generates requests for CreateQuote with any type of body

func NewCreateWalletRequest 

func NewCreateWalletRequest(server string, params *CreateWalletParams, body CreateWalletJSONRequestBody) (*http.Request, error)

NewCreateWalletRequest calls the generic CreateWallet builder with application/json body

func NewCreateWalletRequestWithBody 

func NewCreateWalletRequestWithBody(server string, params *CreateWalletParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateWalletRequestWithBody generates requests for CreateWallet with any type of body

func NewExecuteTradeRequest 

func NewExecuteTradeRequest(server string, params *ExecuteTradeParams, body ExecuteTradeJSONRequestBody) (*http.Request, error)

NewExecuteTradeRequest calls the generic ExecuteTrade builder with application/json body

func NewExecuteTradeRequestWithBody 

func NewExecuteTradeRequestWithBody(server string, params *ExecuteTradeParams, contentType string, body io.Reader) (*http.Request, error)

NewExecuteTradeRequestWithBody generates requests for ExecuteTrade with any type of body

func NewExecuteTransferRequest 

func NewExecuteTransferRequest(server string, params *ExecuteTransferParams, body ExecuteTransferJSONRequestBody) (*http.Request, error)

NewExecuteTransferRequest calls the generic ExecuteTransfer builder with application/json body

func NewExecuteTransferRequestWithBody 

func NewExecuteTransferRequestWithBody(server string, params *ExecuteTransferParams, contentType string, body io.Reader) (*http.Request, error)

NewExecuteTransferRequestWithBody generates requests for ExecuteTransfer with any type of body

func NewGetAssetsRequest 

func NewGetAssetsRequest(server string, params *GetAssetsParams) (*http.Request, error)

NewGetAssetsRequest generates requests for GetAssets

func NewGetBalancesRequest 

func NewGetBalancesRequest(server string, params *GetBalancesParams) (*http.Request, error)

NewGetBalancesRequest generates requests for GetBalances

func NewGetProfileRequest 

func NewGetProfileRequest(server string, params *GetProfileParams) (*http.Request, error)

NewGetProfileRequest generates requests for GetProfile

func NewPrepareTransferRequest 

func NewPrepareTransferRequest(server string, params *PrepareTransferParams, body PrepareTransferJSONRequestBody) (*http.Request, error)

NewPrepareTransferRequest calls the generic PrepareTransfer builder with application/json body

func NewPrepareTransferRequestWithBody 

func NewPrepareTransferRequestWithBody(server string, params *PrepareTransferParams, contentType string, body io.Reader) (*http.Request, error)

NewPrepareTransferRequestWithBody generates requests for PrepareTransfer with any type of body

Types

type Asset 

type Asset struct {
	Address     *string             `json:"address,omitempty"`
	Chain       *string             `json:"chain,omitempty"`
	Decimals    *int                `json:"decimals,omitempty"`
	Description *string             `json:"description,omitempty"`
	Icon        *string             `json:"icon,omitempty"`
	Id          *openapi_types.UUID `json:"id,omitempty"`
	Image       *AssetImage         `json:"image,omitempty"`
	IsActive    *bool               `json:"is_active,omitempty"`
	MarketData  *AssetMarketData    `json:"market_data,omitempty"`
	Name        *string             `json:"name,omitempty"`
	Slug        *string             `json:"slug,omitempty"`
	Socials     *AssetSocials       `json:"socials,omitempty"`
	Stable      *bool               `json:"stable,omitempty"`
	Symbol      *string             `json:"symbol,omitempty"`
	Tradeable   *bool               `json:"tradeable,omitempty"`
	Website     *string             `json:"website,omitempty"`
}

Asset Asset details

type AssetImage 

type AssetImage struct {
	Large *string `json:"large,omitempty"`
	Small *string `json:"small,omitempty"`
	Thumb *string `json:"thumb,omitempty"`
}

AssetImage defines model for AssetImage.

type AssetMarketData 

type AssetMarketData struct {
	CirculatingSupply *int64 `json:"circulating_supply,omitempty"`
	MaxSupply         *int64 `json:"max_supply,omitempty"`
	TotalSupply       *int64 `json:"total_supply,omitempty"`
}

AssetMarketData defines model for AssetMarketData.

type AssetSocials 

type AssetSocials struct {
	FacebookUsername *string `json:"facebook_username,omitempty"`
	OfficialForumUrl *string `json:"official_forum_url,omitempty"`
	SubredditUrl     *string `json:"subreddit_url,omitempty"`
	XUsername        *string `json:"x_username,omitempty"`
}

AssetSocials defines model for AssetSocials.

type Balance 

type Balance struct {
	Asset     *string             `json:"asset,omitempty"`
	Balance   *string             `json:"balance,omitempty"`
	Chain     *string             `json:"chain,omitempty"`
	Decimals  *int                `json:"decimals,omitempty"`
	Icon      *string             `json:"icon,omitempty"`
	Id        *openapi_types.UUID `json:"id,omitempty"`
	Name      *string             `json:"name,omitempty"`
	Stable    *bool               `json:"stable,omitempty"`
	Symbol    *string             `json:"symbol,omitempty"`
	Tradeable *bool               `json:"tradeable,omitempty"`
}

Balance defines model for Balance.

type BalanceResponse 

type BalanceResponse struct {
	Balances *[]Balance `json:"balances,omitempty"`
}

BalanceResponse defines model for BalanceResponse.

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CreateOnramp added in v0.0.10 

func (c *Client) CreateOnramp(ctx context.Context, params *CreateOnrampParams, body CreateOnrampJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateOnrampWithBody added in v0.0.10 

func (c *Client) CreateOnrampWithBody(ctx context.Context, params *CreateOnrampParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateQuote 

func (c *Client) CreateQuote(ctx context.Context, params *CreateQuoteParams, body CreateQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateQuoteWithBody 

func (c *Client) CreateQuoteWithBody(ctx context.Context, params *CreateQuoteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateWallet 

func (c *Client) CreateWallet(ctx context.Context, params *CreateWalletParams, body CreateWalletJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateWalletWithBody 

func (c *Client) CreateWalletWithBody(ctx context.Context, params *CreateWalletParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExecuteTrade 

func (c *Client) ExecuteTrade(ctx context.Context, params *ExecuteTradeParams, body ExecuteTradeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExecuteTradeWithBody 

func (c *Client) ExecuteTradeWithBody(ctx context.Context, params *ExecuteTradeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExecuteTransfer 

func (c *Client) ExecuteTransfer(ctx context.Context, params *ExecuteTransferParams, body ExecuteTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExecuteTransferWithBody 

func (c *Client) ExecuteTransferWithBody(ctx context.Context, params *ExecuteTransferParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAssets 

func (c *Client) GetAssets(ctx context.Context, params *GetAssetsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBalances 

func (c *Client) GetBalances(ctx context.Context, params *GetBalancesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetProfile 

func (c *Client) GetProfile(ctx context.Context, params *GetProfileParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PrepareTransfer 

func (c *Client) PrepareTransfer(ctx context.Context, params *PrepareTransferParams, body PrepareTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PrepareTransferWithBody 

func (c *Client) PrepareTransferWithBody(ctx context.Context, params *PrepareTransferParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// GetAssets request
	GetAssets(ctx context.Context, params *GetAssetsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBalances request
	GetBalances(ctx context.Context, params *GetBalancesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateWalletWithBody request with any body
	CreateWalletWithBody(ctx context.Context, params *CreateWalletParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateWallet(ctx context.Context, params *CreateWalletParams, body CreateWalletJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateOnrampWithBody request with any body
	CreateOnrampWithBody(ctx context.Context, params *CreateOnrampParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateOnramp(ctx context.Context, params *CreateOnrampParams, body CreateOnrampJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetProfile request
	GetProfile(ctx context.Context, params *GetProfileParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateQuoteWithBody request with any body
	CreateQuoteWithBody(ctx context.Context, params *CreateQuoteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateQuote(ctx context.Context, params *CreateQuoteParams, body CreateQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExecuteTradeWithBody request with any body
	ExecuteTradeWithBody(ctx context.Context, params *ExecuteTradeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ExecuteTrade(ctx context.Context, params *ExecuteTradeParams, body ExecuteTradeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExecuteTransferWithBody request with any body
	ExecuteTransferWithBody(ctx context.Context, params *ExecuteTransferParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ExecuteTransfer(ctx context.Context, params *ExecuteTransferParams, body ExecuteTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PrepareTransferWithBody request with any body
	PrepareTransferWithBody(ctx context.Context, params *PrepareTransferParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PrepareTransfer(ctx context.Context, params *PrepareTransferParams, body PrepareTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CreateOnrampWithBodyWithResponse added in v0.0.10 

func (c *ClientWithResponses) CreateOnrampWithBodyWithResponse(ctx context.Context, params *CreateOnrampParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOnrampResponse, error)

CreateOnrampWithBodyWithResponse request with arbitrary body returning *CreateOnrampResponse

func (*ClientWithResponses) CreateOnrampWithResponse added in v0.0.10 

func (c *ClientWithResponses) CreateOnrampWithResponse(ctx context.Context, params *CreateOnrampParams, body CreateOnrampJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOnrampResponse, error)

func (*ClientWithResponses) CreateQuoteWithBodyWithResponse 

func (c *ClientWithResponses) CreateQuoteWithBodyWithResponse(ctx context.Context, params *CreateQuoteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateQuoteResponse, error)

CreateQuoteWithBodyWithResponse request with arbitrary body returning *CreateQuoteResponse

func (*ClientWithResponses) CreateQuoteWithResponse 

func (c *ClientWithResponses) CreateQuoteWithResponse(ctx context.Context, params *CreateQuoteParams, body CreateQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateQuoteResponse, error)

func (*ClientWithResponses) CreateWalletWithBodyWithResponse 

func (c *ClientWithResponses) CreateWalletWithBodyWithResponse(ctx context.Context, params *CreateWalletParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateWalletResponse, error)

CreateWalletWithBodyWithResponse request with arbitrary body returning *CreateWalletResponse

func (*ClientWithResponses) CreateWalletWithResponse 

func (c *ClientWithResponses) CreateWalletWithResponse(ctx context.Context, params *CreateWalletParams, body CreateWalletJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWalletResponse, error)

func (*ClientWithResponses) ExecuteTradeWithBodyWithResponse 

func (c *ClientWithResponses) ExecuteTradeWithBodyWithResponse(ctx context.Context, params *ExecuteTradeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteTradeResponse, error)

ExecuteTradeWithBodyWithResponse request with arbitrary body returning *ExecuteTradeResponse

func (*ClientWithResponses) ExecuteTradeWithResponse 

func (c *ClientWithResponses) ExecuteTradeWithResponse(ctx context.Context, params *ExecuteTradeParams, body ExecuteTradeJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteTradeResponse, error)

func (*ClientWithResponses) ExecuteTransferWithBodyWithResponse 

func (c *ClientWithResponses) ExecuteTransferWithBodyWithResponse(ctx context.Context, params *ExecuteTransferParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteTransferResponse, error)

ExecuteTransferWithBodyWithResponse request with arbitrary body returning *ExecuteTransferResponse

func (*ClientWithResponses) ExecuteTransferWithResponse 

func (c *ClientWithResponses) ExecuteTransferWithResponse(ctx context.Context, params *ExecuteTransferParams, body ExecuteTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteTransferResponse, error)

func (*ClientWithResponses) GetAssetsWithResponse 

func (c *ClientWithResponses) GetAssetsWithResponse(ctx context.Context, params *GetAssetsParams, reqEditors ...RequestEditorFn) (*GetAssetsResponse, error)

GetAssetsWithResponse request returning *GetAssetsResponse

func (*ClientWithResponses) GetBalancesWithResponse 

func (c *ClientWithResponses) GetBalancesWithResponse(ctx context.Context, params *GetBalancesParams, reqEditors ...RequestEditorFn) (*GetBalancesResponse, error)

GetBalancesWithResponse request returning *GetBalancesResponse

func (*ClientWithResponses) GetProfileWithResponse 

func (c *ClientWithResponses) GetProfileWithResponse(ctx context.Context, params *GetProfileParams, reqEditors ...RequestEditorFn) (*GetProfileResponse, error)

GetProfileWithResponse request returning *GetProfileResponse

func (*ClientWithResponses) PrepareTransferWithBodyWithResponse 

func (c *ClientWithResponses) PrepareTransferWithBodyWithResponse(ctx context.Context, params *PrepareTransferParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PrepareTransferResponse, error)

PrepareTransferWithBodyWithResponse request with arbitrary body returning *PrepareTransferResponse

func (*ClientWithResponses) PrepareTransferWithResponse 

func (c *ClientWithResponses) PrepareTransferWithResponse(ctx context.Context, params *PrepareTransferParams, body PrepareTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*PrepareTransferResponse, error)

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetAssetsWithResponse request
	GetAssetsWithResponse(ctx context.Context, params *GetAssetsParams, reqEditors ...RequestEditorFn) (*GetAssetsResponse, error)

	// GetBalancesWithResponse request
	GetBalancesWithResponse(ctx context.Context, params *GetBalancesParams, reqEditors ...RequestEditorFn) (*GetBalancesResponse, error)

	// CreateWalletWithBodyWithResponse request with any body
	CreateWalletWithBodyWithResponse(ctx context.Context, params *CreateWalletParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateWalletResponse, error)

	CreateWalletWithResponse(ctx context.Context, params *CreateWalletParams, body CreateWalletJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWalletResponse, error)

	// CreateOnrampWithBodyWithResponse request with any body
	CreateOnrampWithBodyWithResponse(ctx context.Context, params *CreateOnrampParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOnrampResponse, error)

	CreateOnrampWithResponse(ctx context.Context, params *CreateOnrampParams, body CreateOnrampJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOnrampResponse, error)

	// GetProfileWithResponse request
	GetProfileWithResponse(ctx context.Context, params *GetProfileParams, reqEditors ...RequestEditorFn) (*GetProfileResponse, error)

	// CreateQuoteWithBodyWithResponse request with any body
	CreateQuoteWithBodyWithResponse(ctx context.Context, params *CreateQuoteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateQuoteResponse, error)

	CreateQuoteWithResponse(ctx context.Context, params *CreateQuoteParams, body CreateQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateQuoteResponse, error)

	// ExecuteTradeWithBodyWithResponse request with any body
	ExecuteTradeWithBodyWithResponse(ctx context.Context, params *ExecuteTradeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteTradeResponse, error)

	ExecuteTradeWithResponse(ctx context.Context, params *ExecuteTradeParams, body ExecuteTradeJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteTradeResponse, error)

	// ExecuteTransferWithBodyWithResponse request with any body
	ExecuteTransferWithBodyWithResponse(ctx context.Context, params *ExecuteTransferParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteTransferResponse, error)

	ExecuteTransferWithResponse(ctx context.Context, params *ExecuteTransferParams, body ExecuteTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteTransferResponse, error)

	// PrepareTransferWithBodyWithResponse request with any body
	PrepareTransferWithBodyWithResponse(ctx context.Context, params *PrepareTransferParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PrepareTransferResponse, error)

	PrepareTransferWithResponse(ctx context.Context, params *PrepareTransferParams, body PrepareTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*PrepareTransferResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateOnrampJSONRequestBody added in v0.0.10 

type CreateOnrampJSONRequestBody = OnrampRequest

CreateOnrampJSONRequestBody defines body for CreateOnramp for application/json ContentType.

type CreateOnrampParams added in v0.0.10 

type CreateOnrampParams struct {
	// Version API version date (YYYY-MM-DD)
	Version *Version `form:"version,omitempty" json:"version,omitempty"`
}

CreateOnrampParams defines parameters for CreateOnramp.

type CreateOnrampResponse added in v0.0.10 

type CreateOnrampResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OnrampResponse
	JSON400      *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON401 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON422 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON500 *struct {
		Message *string `json:"message,omitempty"`
	}
}

func ParseCreateOnrampResponse added in v0.0.10 

func ParseCreateOnrampResponse(rsp *http.Response) (*CreateOnrampResponse, error)

ParseCreateOnrampResponse parses an HTTP response from a CreateOnrampWithResponse call

func (CreateOnrampResponse) Status added in v0.0.10 

func (r CreateOnrampResponse) Status() string

Status returns HTTPResponse.Status

func (CreateOnrampResponse) StatusCode added in v0.0.10 

func (r CreateOnrampResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateQuoteJSONRequestBody 

type CreateQuoteJSONRequestBody = QuoteRequest

CreateQuoteJSONRequestBody defines body for CreateQuote for application/json ContentType.

type CreateQuoteParams 

type CreateQuoteParams struct {
	// Version API version date (YYYY-MM-DD)
	Version *Version `form:"version,omitempty" json:"version,omitempty"`
}

CreateQuoteParams defines parameters for CreateQuote.

type CreateQuoteResponse 

type CreateQuoteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *QuoteResponse
	JSON400      *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON401 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON422 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON500 *struct {
		Message *string `json:"message,omitempty"`
	}
}

func ParseCreateQuoteResponse 

func ParseCreateQuoteResponse(rsp *http.Response) (*CreateQuoteResponse, error)

ParseCreateQuoteResponse parses an HTTP response from a CreateQuoteWithResponse call

func (CreateQuoteResponse) Status 

func (r CreateQuoteResponse) Status() string

Status returns HTTPResponse.Status

func (CreateQuoteResponse) StatusCode 

func (r CreateQuoteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateWalletJSONRequestBody 

type CreateWalletJSONRequestBody = CreateWalletRequest

CreateWalletJSONRequestBody defines body for CreateWallet for application/json ContentType.

type CreateWalletParams 

type CreateWalletParams struct {
	// Version API version date (YYYY-MM-DD)
	Version *Version `form:"version,omitempty" json:"version,omitempty"`
}

CreateWalletParams defines parameters for CreateWallet.

type CreateWalletRequest 

type CreateWalletRequest struct {
	ApiKey struct {
		PublicKey string `json:"public_key"`
	} `json:"api_key"`
}

CreateWalletRequest defines model for CreateWalletRequest.

type CreateWalletResponse 

type CreateWalletResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *WalletCreationResult
	JSON400      *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON401 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON500 *struct {
		Message *string `json:"message,omitempty"`
	}
}

func ParseCreateWalletResponse 

func ParseCreateWalletResponse(rsp *http.Response) (*CreateWalletResponse, error)

ParseCreateWalletResponse parses an HTTP response from a CreateWalletWithResponse call

func (CreateWalletResponse) Status 

func (r CreateWalletResponse) Status() string

Status returns HTTPResponse.Status

func (CreateWalletResponse) StatusCode 

func (r CreateWalletResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreatedWallet 

type CreatedWallet struct {
	Address         *string `json:"address,omitempty"`
	AddressType     *string `json:"address_type,omitempty"`
	WalletAccountId *string `json:"wallet_account_id,omitempty"`
	WalletId        *string `json:"wallet_id,omitempty"`
}

CreatedWallet defines model for CreatedWallet.

type ExecuteTradeJSONRequestBody 

type ExecuteTradeJSONRequestBody = TradeRequest

ExecuteTradeJSONRequestBody defines body for ExecuteTrade for application/json ContentType.

type ExecuteTradeParams 

type ExecuteTradeParams struct {
	// Version API version date (YYYY-MM-DD)
	Version *Version `form:"version,omitempty" json:"version,omitempty"`
}

ExecuteTradeParams defines parameters for ExecuteTrade.

type ExecuteTradeResponse 

type ExecuteTradeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TradeResponse
	JSON400      *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON401 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON422 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON500 *struct {
		Message *string `json:"message,omitempty"`
	}
}

func ParseExecuteTradeResponse 

func ParseExecuteTradeResponse(rsp *http.Response) (*ExecuteTradeResponse, error)

ParseExecuteTradeResponse parses an HTTP response from a ExecuteTradeWithResponse call

func (ExecuteTradeResponse) Status 

func (r ExecuteTradeResponse) Status() string

Status returns HTTPResponse.Status

func (ExecuteTradeResponse) StatusCode 

func (r ExecuteTradeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ExecuteTransferJSONRequestBody 

type ExecuteTransferJSONRequestBody = TransferExecuteRequest

ExecuteTransferJSONRequestBody defines body for ExecuteTransfer for application/json ContentType.

type ExecuteTransferParams 

type ExecuteTransferParams struct {
	// Version API version date (YYYY-MM-DD)
	Version *Version `form:"version,omitempty" json:"version,omitempty"`
}

ExecuteTransferParams defines parameters for ExecuteTransfer.

type ExecuteTransferResponse 

type ExecuteTransferResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TransferExecuteResponse
	JSON400      *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON401 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON404 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON422 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON500 *struct {
		Message *string `json:"message,omitempty"`
	}
}

func ParseExecuteTransferResponse 

func ParseExecuteTransferResponse(rsp *http.Response) (*ExecuteTransferResponse, error)

ParseExecuteTransferResponse parses an HTTP response from a ExecuteTransferWithResponse call

func (ExecuteTransferResponse) Status 

func (r ExecuteTransferResponse) Status() string

Status returns HTTPResponse.Status

func (ExecuteTransferResponse) StatusCode 

func (r ExecuteTransferResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAssetsParams 

type GetAssetsParams struct {
	// Version API version date (YYYY-MM-DD)
	Version *Version `form:"version,omitempty" json:"version,omitempty"`

	// Evm Include EVM chain assets
	Evm *bool `form:"evm,omitempty" json:"evm,omitempty"`
}

GetAssetsParams defines parameters for GetAssets.

type GetAssetsResponse 

type GetAssetsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Asset
	JSON500      *struct {
		Message *string `json:"message,omitempty"`
	}
}

func ParseGetAssetsResponse 

func ParseGetAssetsResponse(rsp *http.Response) (*GetAssetsResponse, error)

ParseGetAssetsResponse parses an HTTP response from a GetAssetsWithResponse call

func (GetAssetsResponse) Status 

func (r GetAssetsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAssetsResponse) StatusCode 

func (r GetAssetsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBalancesParams 

type GetBalancesParams struct {
	// Version API version date (YYYY-MM-DD)
	Version *Version `form:"version,omitempty" json:"version,omitempty"`

	// Evm Include EVM chain balances
	Evm *bool `form:"evm,omitempty" json:"evm,omitempty"`
}

GetBalancesParams defines parameters for GetBalances.

type GetBalancesResponse 

type GetBalancesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BalanceResponse
	JSON401      *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON500 *struct {
		Message *string `json:"message,omitempty"`
	}
}

func ParseGetBalancesResponse 

func ParseGetBalancesResponse(rsp *http.Response) (*GetBalancesResponse, error)

ParseGetBalancesResponse parses an HTTP response from a GetBalancesWithResponse call

func (GetBalancesResponse) Status 

func (r GetBalancesResponse) Status() string

Status returns HTTPResponse.Status

func (GetBalancesResponse) StatusCode 

func (r GetBalancesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetProfileParams 

type GetProfileParams struct {
	// Version API version date (YYYY-MM-DD)
	Version *Version `form:"version,omitempty" json:"version,omitempty"`
}

GetProfileParams defines parameters for GetProfile.

type GetProfileResponse 

type GetProfileResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ProfileResponse
	JSON400      *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON401 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON500 *struct {
		Message *string `json:"message,omitempty"`
	}
}

func ParseGetProfileResponse 

func ParseGetProfileResponse(rsp *http.Response) (*GetProfileResponse, error)

ParseGetProfileResponse parses an HTTP response from a GetProfileWithResponse call

func (GetProfileResponse) Status 

func (r GetProfileResponse) Status() string

Status returns HTTPResponse.Status

func (GetProfileResponse) StatusCode 

func (r GetProfileResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type OnrampRequest added in v0.0.10 

type OnrampRequest struct {
	// Amount Fiat amount in USD to onramp
	Amount string `json:"amount"`

	// Chain Blockchain chain (e.g. solana)
	Chain string `json:"chain"`

	// PaymentMethod Payment method for the onramp
	PaymentMethod OnrampRequestPaymentMethod `json:"payment_method"`
}

OnrampRequest defines model for OnrampRequest.

type OnrampRequestPaymentMethod added in v0.0.10 

type OnrampRequestPaymentMethod string

OnrampRequestPaymentMethod Payment method for the onramp 

const (
	CARD OnrampRequestPaymentMethod = "CARD"
)

Defines values for OnrampRequestPaymentMethod.

func (OnrampRequestPaymentMethod) Valid added in v0.0.10 

func (e OnrampRequestPaymentMethod) Valid() bool

Valid indicates whether the value is a known member of the OnrampRequestPaymentMethod enum.

type OnrampResponse added in v0.0.10 

type OnrampResponse struct {
	// Url Time-limited Coinbase onramp URL with embedded session token
	Url *string `json:"url,omitempty"`
}

OnrampResponse defines model for OnrampResponse.

type PrepareTransferJSONRequestBody 

type PrepareTransferJSONRequestBody = TransferPrepareRequest

PrepareTransferJSONRequestBody defines body for PrepareTransfer for application/json ContentType.

type PrepareTransferParams 

type PrepareTransferParams struct {
	// Version API version date (YYYY-MM-DD)
	Version *Version `form:"version,omitempty" json:"version,omitempty"`
}

PrepareTransferParams defines parameters for PrepareTransfer.

type PrepareTransferResponse 

type PrepareTransferResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TransferPrepareResponse
	JSON400      *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON401 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON422 *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON500 *struct {
		Message *string `json:"message,omitempty"`
	}
}

func ParsePrepareTransferResponse 

func ParsePrepareTransferResponse(rsp *http.Response) (*PrepareTransferResponse, error)

ParsePrepareTransferResponse parses an HTTP response from a PrepareTransferWithResponse call

func (PrepareTransferResponse) Status 

func (r PrepareTransferResponse) Status() string

Status returns HTTPResponse.Status

func (PrepareTransferResponse) StatusCode 

func (r PrepareTransferResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ProfileResponse 

type ProfileResponse struct {
	Email   *openapi_types.Email `json:"email,omitempty"`
	Id      *string              `json:"id,omitempty"`
	Wallets *[]Wallet            `json:"wallets,omitempty"`
}

ProfileResponse defines model for ProfileResponse.

type QuoteIssue 

type QuoteIssue struct {
	Balance *QuoteIssueBalance `json:"balance,omitempty"`
	Message string             `json:"message"`
}

QuoteIssue defines model for QuoteIssue.

type QuoteIssueBalance 

type QuoteIssueBalance struct {
	Actual   string `json:"actual"`
	Expected string `json:"expected"`
}

QuoteIssueBalance defines model for QuoteIssueBalance.

type QuoteRequest 

type QuoteRequest struct {
	BaseAsset  string                `json:"base_asset"`
	Chain      string                `json:"chain"`
	OrderSide  QuoteRequestOrderSide `json:"order_side"`
	Qty        string                `json:"qty"`
	QuoteAsset string                `json:"quote_asset"`
}

QuoteRequest defines model for QuoteRequest.

type QuoteRequestOrderSide 

type QuoteRequestOrderSide string

QuoteRequestOrderSide defines model for QuoteRequest.OrderSide. 

const (
	Buy  QuoteRequestOrderSide = "buy"
	Sell QuoteRequestOrderSide = "sell"
)

Defines values for QuoteRequestOrderSide.

func (QuoteRequestOrderSide) Valid 

func (e QuoteRequestOrderSide) Valid() bool

Valid indicates whether the value is a known member of the QuoteRequestOrderSide enum.

type QuoteResponse 

type QuoteResponse struct {
	BaseAsset  string            `json:"base_asset"`
	Fee        string            `json:"fee"`
	FeeAsset   string            `json:"fee_asset"`
	Issues     []QuoteIssue      `json:"issues"`
	OrderSide  string            `json:"order_side"`
	Payloads   []UnsignedPayload `json:"payloads"`
	Qty        string            `json:"qty"`
	QtyOut     string            `json:"qty_out"`
	QuoteAsset string            `json:"quote_asset"`
	QuoteId    string            `json:"quote_id"`
}

QuoteResponse defines model for QuoteResponse.

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type TradeRequest 

type TradeRequest struct {
	// AuthType The authentication type used for signing
	AuthType TradeRequestAuthType `json:"auth_type"`

	// QuoteId The quote ID returned from the quote endpoint
	QuoteId string `json:"quote_id"`

	// Signatures Signatures for the payloads returned from the quote endpoint (in order)
	Signatures []string `json:"signatures"`
}

TradeRequest Trade execution request. Signatures are matched to cached server-side payloads.

type TradeRequestAuthType 

type TradeRequestAuthType string

TradeRequestAuthType The authentication type used for signing 

const (
	TradeRequestAuthTypeApiKey   TradeRequestAuthType = "api_key"
	TradeRequestAuthTypeWebAuthn TradeRequestAuthType = "web_authn"
)

Defines values for TradeRequestAuthType.

func (TradeRequestAuthType) Valid 

func (e TradeRequestAuthType) Valid() bool

Valid indicates whether the value is a known member of the TradeRequestAuthType enum.

type TradeResponse 

type TradeResponse struct {
	// OrderId The created order ID
	OrderId *openapi_types.UUID `json:"order_id,omitempty"`

	// TxHash The blockchain transaction hash
	TxHash *string `json:"tx_hash,omitempty"`
}

TradeResponse Synchronous trade response with order ID and transaction hash

type TransferExecuteRequest 

type TransferExecuteRequest struct {
	// AuthType The authentication type used for signing
	AuthType   TransferExecuteRequestAuthType `json:"auth_type"`
	Signatures []string                       `json:"signatures"`
	TransferId openapi_types.UUID             `json:"transfer_id"`
}

TransferExecuteRequest defines model for TransferExecuteRequest.

type TransferExecuteRequestAuthType 

type TransferExecuteRequestAuthType string

TransferExecuteRequestAuthType The authentication type used for signing 

const (
	TransferExecuteRequestAuthTypeApiKey   TransferExecuteRequestAuthType = "api_key"
	TransferExecuteRequestAuthTypeWebAuthn TransferExecuteRequestAuthType = "web_authn"
)

Defines values for TransferExecuteRequestAuthType.

func (TransferExecuteRequestAuthType) Valid 

func (e TransferExecuteRequestAuthType) Valid() bool

Valid indicates whether the value is a known member of the TransferExecuteRequestAuthType enum.

type TransferExecuteResponse 

type TransferExecuteResponse struct {
	Asset    *string `json:"asset,omitempty"`
	Chain    *string `json:"chain,omitempty"`
	Fee      *string `json:"fee,omitempty"`
	From     *string `json:"from,omitempty"`
	Received *string `json:"received,omitempty"`
	Sent     *string `json:"sent,omitempty"`
	To       *string `json:"to,omitempty"`
	TxHash   *string `json:"tx_hash,omitempty"`
}

TransferExecuteResponse defines model for TransferExecuteResponse.

type TransferPrepareRequest 

type TransferPrepareRequest struct {
	// Asset Asset contract address
	Asset string `json:"asset"`

	// Chain Blockchain chain (e.g., solana, base)
	Chain string `json:"chain"`

	// Qty Transfer quantity
	Qty string `json:"qty"`

	// QtyUnit Unit of quantity (base for token amount, quote for USD)
	QtyUnit TransferPrepareRequestQtyUnit `json:"qty_unit"`

	// To Recipient address
	To string `json:"to"`
}

TransferPrepareRequest defines model for TransferPrepareRequest.

type TransferPrepareRequestQtyUnit 

type TransferPrepareRequestQtyUnit string

TransferPrepareRequestQtyUnit Unit of quantity (base for token amount, quote for USD) 

const (
	Base  TransferPrepareRequestQtyUnit = "base"
	Quote TransferPrepareRequestQtyUnit = "quote"
)

Defines values for TransferPrepareRequestQtyUnit.

func (TransferPrepareRequestQtyUnit) Valid 

func (e TransferPrepareRequestQtyUnit) Valid() bool

Valid indicates whether the value is a known member of the TransferPrepareRequestQtyUnit enum.

type TransferPrepareResponse 

type TransferPrepareResponse struct {
	Payloads   *[]UnsignedPayload  `json:"payloads,omitempty"`
	TransferId *openapi_types.UUID `json:"transfer_id,omitempty"`
}

TransferPrepareResponse defines model for TransferPrepareResponse.

type UnsignedPayload 

type UnsignedPayload struct {
	Digest  string `json:"digest"`
	Payload string `json:"payload"`
}

UnsignedPayload defines model for UnsignedPayload.

type Version 

type Version = string

Version defines model for version.

type Wallet 

type Wallet struct {
	Address *string `json:"address,omitempty"`
	Chain   *string `json:"chain,omitempty"`
}

Wallet defines model for Wallet.

type WalletCreationResult 

type WalletCreationResult struct {
	Wallets *[]CreatedWallet `json:"wallets,omitempty"`
}

WalletCreationResult defines model for WalletCreationResult.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.