orderclient

Documentation

Overview

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

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

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

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

Index

• func NewCreateOrderReplyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• type Client
  • func NewClient(server string, opts ...ClientOption) (*Client, error)
  • func (c *Client) CreateOrderReplyWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*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) CreateOrderReplyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateOrderReplyResponse, error)
• type ClientWithResponsesInterface
• type CreateOrderReplyResponse
  • func ParseCreateOrderReplyResponse(rsp *http.Response) (*CreateOrderReplyResponse, error)
  • func (r CreateOrderReplyResponse) Status() string
  • func (r CreateOrderReplyResponse) StatusCode() int
• type HttpRequestDoer
• type RequestEditorFn

Functions

func NewCreateOrderReplyRequestWithBody

func NewCreateOrderReplyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateOrderReplyRequestWithBody generates requests for CreateOrderReply 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) CreateOrderReplyWithBody

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

type ClientInterface

type ClientInterface interface {
	// CreateOrderReply request with any body
	CreateOrderReplyWithBody(ctx context.Context, contentType string, body io.Reader, 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) CreateOrderReplyWithBodyWithResponse

func (c *ClientWithResponses) CreateOrderReplyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrderReplyResponse, error)

CreateOrderReplyWithBodyWithResponse request with arbitrary body returning *CreateOrderReplyResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// CreateOrderReply request with any body
	CreateOrderReplyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrderReplyResponse, error)
}

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

type CreateOrderReplyResponse

type CreateOrderReplyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseCreateOrderReplyResponse

func ParseCreateOrderReplyResponse(rsp *http.Response) (*CreateOrderReplyResponse, error)

ParseCreateOrderReplyResponse parses an HTTP response from a CreateOrderReplyWithResponse call

func (CreateOrderReplyResponse) Status

func (r CreateOrderReplyResponse) Status() string

Status returns HTTPResponse.Status

func (CreateOrderReplyResponse) StatusCode

func (r CreateOrderReplyResponse) 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 RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function