bitmartspotv1

Documentation

Overview

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

Code generated by github.com/deepmap/oapi-codegen version v1.12.4 DO NOT EDIT.

Index

• func NewGetAllSymbolsDetailsRequest(server string) (*http.Request, error)
• type Client
  • func NewClient(server string, opts ...ClientOption) (*Client, error)
  • func (c *Client) GetAllSymbolsDetails(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
• type ClientInterface
• type ClientOption
  • func WithBaseURL(baseURL string) ClientOption
  • func WithHTTPClient(doer HttpRequestDoer) ClientOption
  • func WithRequestEditorFn(fn RequestEditorFn) ClientOption
• type ClientWithResponses
  • func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
  • func (c *ClientWithResponses) GetAllSymbolsDetailsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAllSymbolsDetailsResponse, error)
• type ClientWithResponsesInterface
• type GetAllSymbolsDetailsResponse
  • func ParseGetAllSymbolsDetailsResponse(rsp *http.Response) (*GetAllSymbolsDetailsResponse, error)
  • func (r GetAllSymbolsDetailsResponse) Status() string
  • func (r GetAllSymbolsDetailsResponse) StatusCode() int
• type GetSymbolsDetailsData
  • func (a GetSymbolsDetailsData) Get(fieldName string) (value interface{}, found bool)
  • func (a GetSymbolsDetailsData) MarshalJSON() ([]byte, error)
  • func (a *GetSymbolsDetailsData) Set(fieldName string, value interface{})
  • func (a *GetSymbolsDetailsData) UnmarshalJSON(b []byte) error
• type GetSymbolsDetailsResponse
  • func (a GetSymbolsDetailsResponse) Get(fieldName string) (value interface{}, found bool)
  • func (a GetSymbolsDetailsResponse) MarshalJSON() ([]byte, error)
  • func (a *GetSymbolsDetailsResponse) Set(fieldName string, value interface{})
  • func (a *GetSymbolsDetailsResponse) UnmarshalJSON(b []byte) error
• type HttpRequestDoer
• type RequestEditorFn
• type Symbol
  • func (a Symbol) Get(fieldName string) (value interface{}, found bool)
  • func (a Symbol) MarshalJSON() ([]byte, error)
  • func (a *Symbol) Set(fieldName string, value interface{})
  • func (a *Symbol) UnmarshalJSON(b []byte) error

Functions

func NewGetAllSymbolsDetailsRequest

func NewGetAllSymbolsDetailsRequest(server string) (*http.Request, error)

NewGetAllSymbolsDetailsRequest generates requests for GetAllSymbolsDetails

Types

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) GetAllSymbolsDetails

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

type ClientInterface

type ClientInterface interface {
	// GetAllSymbolsDetails request
	GetAllSymbolsDetails(ctx context.Context, 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) GetAllSymbolsDetailsWithResponse

func (c *ClientWithResponses) GetAllSymbolsDetailsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAllSymbolsDetailsResponse, error)

GetAllSymbolsDetailsWithResponse request returning *GetAllSymbolsDetailsResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetAllSymbolsDetails request
	GetAllSymbolsDetailsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAllSymbolsDetailsResponse, error)
}

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

type GetAllSymbolsDetailsResponse

type GetAllSymbolsDetailsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetSymbolsDetailsResponse
}

func ParseGetAllSymbolsDetailsResponse

func ParseGetAllSymbolsDetailsResponse(rsp *http.Response) (*GetAllSymbolsDetailsResponse, error)

ParseGetAllSymbolsDetailsResponse parses an HTTP response from a GetAllSymbolsDetailsWithResponse call

func (GetAllSymbolsDetailsResponse) Status

func (r GetAllSymbolsDetailsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllSymbolsDetailsResponse) StatusCode

func (r GetAllSymbolsDetailsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSymbolsDetailsData

type GetSymbolsDetailsData struct {
	Symbols              []Symbol               `json:"symbols"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

GetSymbolsDetailsData defines model for getSymbolsDetailsData.

func (GetSymbolsDetailsData) Get

func (a GetSymbolsDetailsData) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for GetSymbolsDetailsData. Returns the specified element and whether it was found

func (GetSymbolsDetailsData) MarshalJSON

func (a GetSymbolsDetailsData) MarshalJSON() ([]byte, error)

Override default JSON handling for GetSymbolsDetailsData to handle AdditionalProperties

func (*GetSymbolsDetailsData) Set

func (a *GetSymbolsDetailsData) Set(fieldName string, value interface{})

Setter for additional properties for GetSymbolsDetailsData

func (*GetSymbolsDetailsData) UnmarshalJSON

func (a *GetSymbolsDetailsData) UnmarshalJSON(b []byte) error

Override default JSON handling for GetSymbolsDetailsData to handle AdditionalProperties

type GetSymbolsDetailsResponse

type GetSymbolsDetailsResponse struct {
	Code                 int                    `json:"code"`
	Data                 GetSymbolsDetailsData  `json:"data"`
	Message              string                 `json:"message"`
	Trace                string                 `json:"trace"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

GetSymbolsDetailsResponse defines model for getSymbolsDetailsResponse.

func (GetSymbolsDetailsResponse) Get

func (a GetSymbolsDetailsResponse) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for GetSymbolsDetailsResponse. Returns the specified element and whether it was found

func (GetSymbolsDetailsResponse) MarshalJSON

func (a GetSymbolsDetailsResponse) MarshalJSON() ([]byte, error)

Override default JSON handling for GetSymbolsDetailsResponse to handle AdditionalProperties

func (*GetSymbolsDetailsResponse) Set

func (a *GetSymbolsDetailsResponse) Set(fieldName string, value interface{})

Setter for additional properties for GetSymbolsDetailsResponse

func (*GetSymbolsDetailsResponse) UnmarshalJSON

func (a *GetSymbolsDetailsResponse) UnmarshalJSON(b []byte) error

Override default JSON handling for GetSymbolsDetailsResponse to handle AdditionalProperties

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type Symbol

type Symbol struct {
	BaseCurrency         string                 `json:"base_currency"`
	BaseMinSize          string                 `json:"base_min_size"`
	Expiration           string                 `json:"expiration"`
	MinBuyAmount         string                 `json:"min_buy_amount"`
	MinSellAmount        string                 `json:"min_sell_amount"`
	PriceMaxPrecision    int                    `json:"price_max_precision"`
	PriceMinPrecision    int                    `json:"price_min_precision"`
	QuoteCurrency        string                 `json:"quote_currency"`
	QuoteIncrement       string                 `json:"quote_increment"`
	Symbol               string                 `json:"symbol"`
	SymbolId             int                    `json:"symbol_id"`
	TradeStatus          string                 `json:"trade_status"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

Symbol defines model for symbol.

func (Symbol) Get

func (a Symbol) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for Symbol. Returns the specified element and whether it was found

func (Symbol) MarshalJSON

func (a Symbol) MarshalJSON() ([]byte, error)

Override default JSON handling for Symbol to handle AdditionalProperties

func (*Symbol) Set

func (a *Symbol) Set(fieldName string, value interface{})

Setter for additional properties for Symbol

func (*Symbol) UnmarshalJSON

func (a *Symbol) UnmarshalJSON(b []byte) error

Override default JSON handling for Symbol to handle AdditionalProperties