api

package
v1.2.0 Latest Latest
Warning

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

Go to latest
Published: Jul 8, 2025 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewGetApiV2TipWalletRequest

func NewGetApiV2TipWalletRequest(server string, params *GetApiV2TipWalletParams) (*http.Request, error)

NewGetApiV2TipWalletRequest generates requests for GetApiV2TipWallet

func NewPostApiV2SubmitBatchRequest

func NewPostApiV2SubmitBatchRequest(server string, params *PostApiV2SubmitBatchParams, body PostApiV2SubmitBatchJSONRequestBody) (*http.Request, error)

NewPostApiV2SubmitBatchRequest calls the generic PostApiV2SubmitBatch builder with application/json body

func NewPostApiV2SubmitBatchRequestWithBody

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

NewPostApiV2SubmitBatchRequestWithBody generates requests for PostApiV2SubmitBatch with any type of body

func NewPostApiV2SubmitRequest

func NewPostApiV2SubmitRequest(server string, params *PostApiV2SubmitParams, body PostApiV2SubmitJSONRequestBody) (*http.Request, error)

NewPostApiV2SubmitRequest calls the generic PostApiV2Submit builder with application/json body

func NewPostApiV2SubmitRequestWithBody

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

NewPostApiV2SubmitRequestWithBody generates requests for PostApiV2Submit with any type of body

func NewPostApiV2TipWalletRequest

func NewPostApiV2TipWalletRequest(server string, params *PostApiV2TipWalletParams, body PostApiV2TipWalletJSONRequestBody) (*http.Request, error)

NewPostApiV2TipWalletRequest calls the generic PostApiV2TipWallet builder with application/json body

func NewPostApiV2TipWalletRequestWithBody

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

NewPostApiV2TipWalletRequestWithBody generates requests for PostApiV2TipWallet with any type of body

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

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

func (*Client) PostApiV2Submit

func (c *Client) PostApiV2Submit(ctx context.Context, params *PostApiV2SubmitParams, body PostApiV2SubmitJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostApiV2SubmitBatch

func (c *Client) PostApiV2SubmitBatch(ctx context.Context, params *PostApiV2SubmitBatchParams, body PostApiV2SubmitBatchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostApiV2SubmitBatchWithBody

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

func (*Client) PostApiV2SubmitWithBody

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

func (*Client) PostApiV2TipWallet

func (c *Client) PostApiV2TipWallet(ctx context.Context, params *PostApiV2TipWalletParams, body PostApiV2TipWalletJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostApiV2TipWalletWithBody

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

type ClientInterface

type ClientInterface interface {
	// PostApiV2SubmitWithBody request with any body
	PostApiV2SubmitWithBody(ctx context.Context, params *PostApiV2SubmitParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiV2Submit(ctx context.Context, params *PostApiV2SubmitParams, body PostApiV2SubmitJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	PostApiV2SubmitBatch(ctx context.Context, params *PostApiV2SubmitBatchParams, body PostApiV2SubmitBatchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	PostApiV2TipWallet(ctx context.Context, params *PostApiV2TipWalletParams, body PostApiV2TipWalletJSONRequestBody, 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) GetApiV2TipWalletWithResponse

func (c *ClientWithResponses) GetApiV2TipWalletWithResponse(ctx context.Context, params *GetApiV2TipWalletParams, reqEditors ...RequestEditorFn) (*GetApiV2TipWalletResponse, error)

GetApiV2TipWalletWithResponse request returning *GetApiV2TipWalletResponse

func (*ClientWithResponses) PostApiV2SubmitBatchWithBodyWithResponse

func (c *ClientWithResponses) PostApiV2SubmitBatchWithBodyWithResponse(ctx context.Context, params *PostApiV2SubmitBatchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiV2SubmitBatchResponse, error)

PostApiV2SubmitBatchWithBodyWithResponse request with arbitrary body returning *PostApiV2SubmitBatchResponse

func (*ClientWithResponses) PostApiV2SubmitBatchWithResponse

func (*ClientWithResponses) PostApiV2SubmitWithBodyWithResponse

func (c *ClientWithResponses) PostApiV2SubmitWithBodyWithResponse(ctx context.Context, params *PostApiV2SubmitParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiV2SubmitResponse, error)

PostApiV2SubmitWithBodyWithResponse request with arbitrary body returning *PostApiV2SubmitResponse

func (*ClientWithResponses) PostApiV2SubmitWithResponse

func (c *ClientWithResponses) PostApiV2SubmitWithResponse(ctx context.Context, params *PostApiV2SubmitParams, body PostApiV2SubmitJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiV2SubmitResponse, error)

func (*ClientWithResponses) PostApiV2TipWalletWithBodyWithResponse

func (c *ClientWithResponses) PostApiV2TipWalletWithBodyWithResponse(ctx context.Context, params *PostApiV2TipWalletParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiV2TipWalletResponse, error)

PostApiV2TipWalletWithBodyWithResponse request with arbitrary body returning *PostApiV2TipWalletResponse

func (*ClientWithResponses) PostApiV2TipWalletWithResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// PostApiV2SubmitWithBodyWithResponse request with any body
	PostApiV2SubmitWithBodyWithResponse(ctx context.Context, params *PostApiV2SubmitParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiV2SubmitResponse, error)

	PostApiV2SubmitWithResponse(ctx context.Context, params *PostApiV2SubmitParams, body PostApiV2SubmitJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiV2SubmitResponse, error)

	// PostApiV2SubmitBatchWithBodyWithResponse request with any body
	PostApiV2SubmitBatchWithBodyWithResponse(ctx context.Context, params *PostApiV2SubmitBatchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiV2SubmitBatchResponse, error)

	PostApiV2SubmitBatchWithResponse(ctx context.Context, params *PostApiV2SubmitBatchParams, body PostApiV2SubmitBatchJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiV2SubmitBatchResponse, error)

	// GetApiV2TipWalletWithResponse request
	GetApiV2TipWalletWithResponse(ctx context.Context, params *GetApiV2TipWalletParams, reqEditors ...RequestEditorFn) (*GetApiV2TipWalletResponse, error)

	// PostApiV2TipWalletWithBodyWithResponse request with any body
	PostApiV2TipWalletWithBodyWithResponse(ctx context.Context, params *PostApiV2TipWalletParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiV2TipWalletResponse, error)

	PostApiV2TipWalletWithResponse(ctx context.Context, params *PostApiV2TipWalletParams, body PostApiV2TipWalletJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiV2TipWalletResponse, error)
}

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

type ErrorResponse

type ErrorResponse struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

ErrorResponse defines model for ErrorResponse.

type GetApiV2TipWalletParams

type GetApiV2TipWalletParams struct {
	// Authorization authorization header
	Authorization string `json:"Authorization"`
}

GetApiV2TipWalletParams defines parameters for GetApiV2TipWallet.

type GetApiV2TipWalletResponse

type GetApiV2TipWalletResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TipWalletResponse
	JSON400      *ErrorResponse
	JSON404      *ErrorResponse
	JSON500      *ErrorResponse
}

func ParseGetApiV2TipWalletResponse

func ParseGetApiV2TipWalletResponse(rsp *http.Response) (*GetApiV2TipWalletResponse, error)

ParseGetApiV2TipWalletResponse parses an HTTP response from a GetApiV2TipWalletWithResponse call

func (GetApiV2TipWalletResponse) Status

func (r GetApiV2TipWalletResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV2TipWalletResponse) StatusCode

func (r GetApiV2TipWalletResponse) 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 PostApiV2SubmitBatchJSONRequestBody

type PostApiV2SubmitBatchJSONRequestBody = SubmitBatchRequest

PostApiV2SubmitBatchJSONRequestBody defines body for PostApiV2SubmitBatch for application/json ContentType.

type PostApiV2SubmitBatchParams

type PostApiV2SubmitBatchParams struct {
	// Authorization authorization header
	Authorization string `json:"Authorization"`
}

PostApiV2SubmitBatchParams defines parameters for PostApiV2SubmitBatch.

type PostApiV2SubmitBatchResponse

type PostApiV2SubmitBatchResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SubmitBatchResponse
	JSON400      *ErrorResponse
	JSON404      *ErrorResponse
	JSON500      *ErrorResponse
}

func ParsePostApiV2SubmitBatchResponse

func ParsePostApiV2SubmitBatchResponse(rsp *http.Response) (*PostApiV2SubmitBatchResponse, error)

ParsePostApiV2SubmitBatchResponse parses an HTTP response from a PostApiV2SubmitBatchWithResponse call

func (PostApiV2SubmitBatchResponse) Status

Status returns HTTPResponse.Status

func (PostApiV2SubmitBatchResponse) StatusCode

func (r PostApiV2SubmitBatchResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiV2SubmitJSONRequestBody

type PostApiV2SubmitJSONRequestBody = SubmitRequest

PostApiV2SubmitJSONRequestBody defines body for PostApiV2Submit for application/json ContentType.

type PostApiV2SubmitParams

type PostApiV2SubmitParams struct {
	// Authorization authorization header
	Authorization string `json:"Authorization"`
}

PostApiV2SubmitParams defines parameters for PostApiV2Submit.

type PostApiV2SubmitResponse

type PostApiV2SubmitResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SubmitResponse
	JSON400      *ErrorResponse
	JSON404      *ErrorResponse
	JSON500      *ErrorResponse
}

func ParsePostApiV2SubmitResponse

func ParsePostApiV2SubmitResponse(rsp *http.Response) (*PostApiV2SubmitResponse, error)

ParsePostApiV2SubmitResponse parses an HTTP response from a PostApiV2SubmitWithResponse call

func (PostApiV2SubmitResponse) Status

func (r PostApiV2SubmitResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiV2SubmitResponse) StatusCode

func (r PostApiV2SubmitResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiV2TipWalletJSONRequestBody

type PostApiV2TipWalletJSONRequestBody = TipWalletRequest

PostApiV2TipWalletJSONRequestBody defines body for PostApiV2TipWallet for application/json ContentType.

type PostApiV2TipWalletParams

type PostApiV2TipWalletParams struct {
	// Authorization authorization header
	Authorization string `json:"Authorization"`
}

PostApiV2TipWalletParams defines parameters for PostApiV2TipWallet.

type PostApiV2TipWalletResponse

type PostApiV2TipWalletResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TipWalletResponse
	JSON400      *ErrorResponse
	JSON404      *ErrorResponse
	JSON500      *ErrorResponse
}

func ParsePostApiV2TipWalletResponse

func ParsePostApiV2TipWalletResponse(rsp *http.Response) (*PostApiV2TipWalletResponse, error)

ParsePostApiV2TipWalletResponse parses an HTTP response from a PostApiV2TipWalletWithResponse call

func (PostApiV2TipWalletResponse) Status

Status returns HTTPResponse.Status

func (PostApiV2TipWalletResponse) StatusCode

func (r PostApiV2TipWalletResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type SubmitBatchRequest

type SubmitBatchRequest struct {
	// ExpirationTimeSec Expiration time in seconds for the batch landing. If not set, defaults to 18 seconds or time left to the next block time depending on transactions.
	ExpirationTimeSec *int `json:"expiration_time_sec,omitempty"`

	// TippingWallet Sending wallet type for a tipping transaction
	TippingWallet SubmitBatchRequestTippingWallet `json:"tipping_wallet"`

	// Transactions Array of signed TON transactions with wallet types.
	Transactions []struct {
		// Content The signed payload of the TON transaction (in base64).
		Content string `json:"content"`
	} `json:"transactions"`
}

SubmitBatchRequest defines model for SubmitBatchRequest.

type SubmitBatchRequestTippingWallet

type SubmitBatchRequestTippingWallet string

SubmitBatchRequestTippingWallet Sending wallet type for a tipping transaction

const (
	SubmitBatchRequestTippingWalletHighloadV2R2 SubmitBatchRequestTippingWallet = "HighloadV2R2"
	SubmitBatchRequestTippingWalletHighloadV3   SubmitBatchRequestTippingWallet = "HighloadV3"
	SubmitBatchRequestTippingWalletV4R2         SubmitBatchRequestTippingWallet = "V4R2"
	SubmitBatchRequestTippingWalletV5R1Final    SubmitBatchRequestTippingWallet = "V5R1Final"
)

Defines values for SubmitBatchRequestTippingWallet.

type SubmitBatchResponse

type SubmitBatchResponse struct {
	// MsgBodyHashes The hashes of the bodies of the external messages passed by the user in the submit batch request
	MsgBodyHashes []string `json:"msg_body_hashes"`
}

SubmitBatchResponse defines model for SubmitBatchResponse.

type SubmitRequest

type SubmitRequest struct {
	Transaction struct {
		// Content The signed payload of the TON transaction (in base64).
		Content string `json:"content"`
	} `json:"transaction"`

	// UseMevProtection Use MEV protected submission route
	UseMevProtection *bool `json:"use_mev_protection,omitempty"`

	// Wallet Sending wallet type
	Wallet SubmitRequestWallet `json:"wallet"`
}

SubmitRequest defines model for SubmitRequest.

type SubmitRequestWallet

type SubmitRequestWallet string

SubmitRequestWallet Sending wallet type

const (
	SubmitRequestWalletHighloadV2R2 SubmitRequestWallet = "HighloadV2R2"
	SubmitRequestWalletHighloadV3   SubmitRequestWallet = "HighloadV3"
	SubmitRequestWalletV4R2         SubmitRequestWallet = "V4R2"
	SubmitRequestWalletV5R1Final    SubmitRequestWallet = "V5R1Final"
)

Defines values for SubmitRequestWallet.

type SubmitResponse

type SubmitResponse struct {
	// MsgBodyHash The hash of the body of the external messsage passed by the user in the submit request
	MsgBodyHash string `json:"msg_body_hash"`
}

SubmitResponse defines model for SubmitResponse.

type TipWalletRequest

type TipWalletRequest struct {
	// Address Sender wallet address.
	Address          *string   `json:"address,omitempty"`
	ExternalMessages *[]string `json:"external_messages,omitempty"`
	// contains filtered or unexported fields
}

TipWalletRequest defines model for TipWalletRequest.

func (TipWalletRequest) AsTipWalletRequest0

func (t TipWalletRequest) AsTipWalletRequest0() (TipWalletRequest0, error)

AsTipWalletRequest0 returns the union data inside the TipWalletRequest as a TipWalletRequest0

func (TipWalletRequest) AsTipWalletRequest1

func (t TipWalletRequest) AsTipWalletRequest1() (TipWalletRequest1, error)

AsTipWalletRequest1 returns the union data inside the TipWalletRequest as a TipWalletRequest1

func (*TipWalletRequest) FromTipWalletRequest0

func (t *TipWalletRequest) FromTipWalletRequest0(v TipWalletRequest0) error

FromTipWalletRequest0 overwrites any union data inside the TipWalletRequest as the provided TipWalletRequest0

func (*TipWalletRequest) FromTipWalletRequest1

func (t *TipWalletRequest) FromTipWalletRequest1(v TipWalletRequest1) error

FromTipWalletRequest1 overwrites any union data inside the TipWalletRequest as the provided TipWalletRequest1

func (TipWalletRequest) MarshalJSON

func (t TipWalletRequest) MarshalJSON() ([]byte, error)

func (*TipWalletRequest) MergeTipWalletRequest0

func (t *TipWalletRequest) MergeTipWalletRequest0(v TipWalletRequest0) error

MergeTipWalletRequest0 performs a merge with any union data inside the TipWalletRequest, using the provided TipWalletRequest0

func (*TipWalletRequest) MergeTipWalletRequest1

func (t *TipWalletRequest) MergeTipWalletRequest1(v TipWalletRequest1) error

MergeTipWalletRequest1 performs a merge with any union data inside the TipWalletRequest, using the provided TipWalletRequest1

func (*TipWalletRequest) UnmarshalJSON

func (t *TipWalletRequest) UnmarshalJSON(b []byte) error

type TipWalletRequest0

type TipWalletRequest0 = interface{}

TipWalletRequest0 defines model for .

type TipWalletRequest1

type TipWalletRequest1 = interface{}

TipWalletRequest1 defines model for .

type TipWalletResponse

type TipWalletResponse struct {
	// Shard Shard id in hex format
	Shard string `json:"shard"`

	// TipWalletAddress Tip wallet address to be used for transaction or bundle submission
	TipWalletAddress string `json:"tip_wallet_address"`
}

TipWalletResponse defines model for TipWalletResponse.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL