bybitspotv3

Documentation

Overview

Package bybitspotv3 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 NewGetAllSymbolsRequest(server string) (*http.Request, error)
• type Client
  • func NewClient(server string, opts ...ClientOption) (*Client, error)
  • func (c *Client) GetAllSymbols(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) GetAllSymbolsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAllSymbolsResponse, error)
• type ClientWithResponsesInterface
• type GetAllSymbolsResponse
  • func ParseGetAllSymbolsResponse(rsp *http.Response) (*GetAllSymbolsResponse, error)
  • func (r GetAllSymbolsResponse) Status() string
  • func (r GetAllSymbolsResponse) StatusCode() int
• type GetSymbolsData
  • func (a GetSymbolsData) Get(fieldName string) (value interface{}, found bool)
  • func (a GetSymbolsData) MarshalJSON() ([]byte, error)
  • func (a *GetSymbolsData) Set(fieldName string, value interface{})
  • func (a *GetSymbolsData) UnmarshalJSON(b []byte) error
• type GetSymbolsResponse
  • func (a GetSymbolsResponse) Get(fieldName string) (value interface{}, found bool)
  • func (a GetSymbolsResponse) MarshalJSON() ([]byte, error)
  • func (a *GetSymbolsResponse) Set(fieldName string, value interface{})
  • func (a *GetSymbolsResponse) 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 NewGetAllSymbolsRequest

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

NewGetAllSymbolsRequest generates requests for GetAllSymbols

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

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

type ClientInterface

type ClientInterface interface {
	// GetAllSymbols request
	GetAllSymbols(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) GetAllSymbolsWithResponse

func (c *ClientWithResponses) GetAllSymbolsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAllSymbolsResponse, error)

GetAllSymbolsWithResponse request returning *GetAllSymbolsResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetAllSymbols request
	GetAllSymbolsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAllSymbolsResponse, error)
}

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

type GetAllSymbolsResponse

type GetAllSymbolsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetSymbolsResponse
}

func ParseGetAllSymbolsResponse

func ParseGetAllSymbolsResponse(rsp *http.Response) (*GetAllSymbolsResponse, error)

ParseGetAllSymbolsResponse parses an HTTP response from a GetAllSymbolsWithResponse call

func (GetAllSymbolsResponse) Status

func (r GetAllSymbolsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllSymbolsResponse) StatusCode

func (r GetAllSymbolsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSymbolsData

type GetSymbolsData struct {
	List                 []Symbol               `json:"list"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

GetSymbolsData defines model for getSymbolsData.

func (GetSymbolsData) Get

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

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

func (GetSymbolsData) MarshalJSON

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

Override default JSON handling for GetSymbolsData to handle AdditionalProperties

func (*GetSymbolsData) Set

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

Setter for additional properties for GetSymbolsData

func (*GetSymbolsData) UnmarshalJSON

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

Override default JSON handling for GetSymbolsData to handle AdditionalProperties

type GetSymbolsResponse

type GetSymbolsResponse struct {
	Result               *GetSymbolsData        `json:"result,omitempty"`
	RetCode              int                    `json:"retCode"`
	RetMsg               string                 `json:"retMsg"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

GetSymbolsResponse defines model for getSymbolsResponse.

func (GetSymbolsResponse) Get

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

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

func (GetSymbolsResponse) MarshalJSON

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

Override default JSON handling for GetSymbolsResponse to handle AdditionalProperties

func (*GetSymbolsResponse) Set

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

Setter for additional properties for GetSymbolsResponse

func (*GetSymbolsResponse) UnmarshalJSON

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

Override default JSON handling for GetSymbolsResponse 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 {
	Alias                string                 `json:"alias"`
	BaseCoin             string                 `json:"baseCoin"`
	BasePrecision        string                 `json:"basePrecision"`
	Category             string                 `json:"category"`
	Innovation           string                 `json:"innovation"`
	MaxTradeAmt          string                 `json:"maxTradeAmt"`
	MaxTradeQty          string                 `json:"maxTradeQty"`
	MinPricePrecision    string                 `json:"minPricePrecision"`
	MinTradeAmt          string                 `json:"minTradeAmt"`
	MinTradeQty          string                 `json:"minTradeQty"`
	Name                 string                 `json:"name"`
	QuoteCoin            string                 `json:"quoteCoin"`
	QuotePrecision       string                 `json:"quotePrecision"`
	ShowStatus           string                 `json:"showStatus"`
	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