client

package
v1.13.4 Latest Latest
Warning

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

 Go to latest Published: Aug 7, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

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

Code generated by github.com/deepmap/oapi-codegen version (devel) DO NOT EDIT.

Index

Constants

View Source 
const (
	OpenIdScopes = "OpenId.Scopes"
)

Variables

This section is empty.

Functions

func NewGetBothRequest 

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

NewGetBothRequest generates requests for GetBoth

func NewGetJsonRequest 

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

NewGetJsonRequest generates requests for GetJson

func NewGetJsonWithTrailingSlashRequest added in v1.3.4 

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

NewGetJsonWithTrailingSlashRequest generates requests for GetJsonWithTrailingSlash

func NewGetOtherRequest 

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

NewGetOtherRequest generates requests for GetOther

func NewPostBothRequest 

func NewPostBothRequest(server string, body PostBothJSONRequestBody) (*http.Request, error)

NewPostBothRequest calls the generic PostBoth builder with application/json body

func NewPostBothRequestWithBody 

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

NewPostBothRequestWithBody generates requests for PostBoth with any type of body

func NewPostJsonRequest 

func NewPostJsonRequest(server string, body PostJsonJSONRequestBody) (*http.Request, error)

NewPostJsonRequest calls the generic PostJson builder with application/json body

func NewPostJsonRequestWithBody 

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

NewPostJsonRequestWithBody generates requests for PostJson with any type of body

func NewPostOtherRequestWithBody 

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

NewPostOtherRequestWithBody generates requests for PostOther with any type of body

func NewPostVendorJsonRequestWithApplicationVndAPIPlusJSONBody added in v1.13.2 

func NewPostVendorJsonRequestWithApplicationVndAPIPlusJSONBody(server string, body PostVendorJsonApplicationVndAPIPlusJSONRequestBody) (*http.Request, error)

NewPostVendorJsonRequestWithApplicationVndAPIPlusJSONBody calls the generic PostVendorJson builder with application/vnd.api+json body

func NewPostVendorJsonRequestWithBody added in v1.12.0 

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

NewPostVendorJsonRequestWithBody generates requests for PostVendorJson 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 added in v1.3.1 

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

Creates a new Client, with reasonable defaults

func (*Client) GetBoth 

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

func (*Client) GetJson 

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

func (*Client) GetJsonWithTrailingSlash added in v1.3.4 

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

func (*Client) GetOther 

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

func (*Client) PostBoth 

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

func (*Client) PostBothWithBody 

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

func (*Client) PostJson 

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

func (*Client) PostJsonWithBody 

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

func (*Client) PostOtherWithBody 

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

func (*Client) PostVendorJsonWithApplicationVndAPIPlusJSONBody added in v1.13.2 

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

func (*Client) PostVendorJsonWithBody added in v1.12.0 

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

type ClientInterface 

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

	PostBoth(ctx context.Context, body PostBothJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBoth request
	GetBoth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	PostJson(ctx context.Context, body PostJsonJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetJson request
	GetJson(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// GetOther request
	GetOther(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetJsonWithTrailingSlash request
	GetJsonWithTrailingSlash(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	PostVendorJsonWithApplicationVndAPIPlusJSONBody(ctx context.Context, body PostVendorJsonApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption added in v1.3.1 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL added in v1.3.1 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient added in v1.3.1 

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 added in v1.3.1 

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

func (c *ClientWithResponses) GetBothWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetBothResponse, error)

GetBothWithResponse request returning *GetBothResponse

func (*ClientWithResponses) GetJsonWithResponse 

func (c *ClientWithResponses) GetJsonWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJsonResponse, error)

GetJsonWithResponse request returning *GetJsonResponse

func (*ClientWithResponses) GetJsonWithTrailingSlashWithResponse added in v1.3.4 

func (c *ClientWithResponses) GetJsonWithTrailingSlashWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJsonWithTrailingSlashResponse, error)

GetJsonWithTrailingSlashWithResponse request returning *GetJsonWithTrailingSlashResponse

func (*ClientWithResponses) GetOtherWithResponse 

func (c *ClientWithResponses) GetOtherWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOtherResponse, error)

GetOtherWithResponse request returning *GetOtherResponse

func (*ClientWithResponses) PostBothWithBodyWithResponse 

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

PostBothWithBodyWithResponse request with arbitrary body returning *PostBothResponse

func (*ClientWithResponses) PostBothWithResponse 

func (c *ClientWithResponses) PostBothWithResponse(ctx context.Context, body PostBothJSONRequestBody, reqEditors ...RequestEditorFn) (*PostBothResponse, error)

func (*ClientWithResponses) PostJsonWithBodyWithResponse 

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

PostJsonWithBodyWithResponse request with arbitrary body returning *PostJsonResponse

func (*ClientWithResponses) PostJsonWithResponse 

func (c *ClientWithResponses) PostJsonWithResponse(ctx context.Context, body PostJsonJSONRequestBody, reqEditors ...RequestEditorFn) (*PostJsonResponse, error)

func (*ClientWithResponses) PostOtherWithBodyWithResponse 

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

PostOtherWithBodyWithResponse request with arbitrary body returning *PostOtherResponse

func (*ClientWithResponses) PostVendorJsonWithApplicationVndAPIPlusJSONBodyWithResponse added in v1.13.2 

func (c *ClientWithResponses) PostVendorJsonWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, body PostVendorJsonApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*PostVendorJsonResponse, error)

func (*ClientWithResponses) PostVendorJsonWithBodyWithResponse added in v1.12.0 

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

PostVendorJsonWithBodyWithResponse request with arbitrary body returning *PostVendorJsonResponse

type ClientWithResponsesInterface added in v1.3.8 

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

	PostBothWithResponse(ctx context.Context, body PostBothJSONRequestBody, reqEditors ...RequestEditorFn) (*PostBothResponse, error)

	// GetBothWithResponse request
	GetBothWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetBothResponse, error)

	// PostJsonWithBodyWithResponse request with any body
	PostJsonWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostJsonResponse, error)

	PostJsonWithResponse(ctx context.Context, body PostJsonJSONRequestBody, reqEditors ...RequestEditorFn) (*PostJsonResponse, error)

	// GetJsonWithResponse request
	GetJsonWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJsonResponse, error)

	// PostOtherWithBodyWithResponse request with any body
	PostOtherWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostOtherResponse, error)

	// GetOtherWithResponse request
	GetOtherWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOtherResponse, error)

	// GetJsonWithTrailingSlashWithResponse request
	GetJsonWithTrailingSlashWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJsonWithTrailingSlashResponse, error)

	// PostVendorJsonWithBodyWithResponse request with any body
	PostVendorJsonWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostVendorJsonResponse, error)

	PostVendorJsonWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, body PostVendorJsonApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*PostVendorJsonResponse, error)
}

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

type GetBothResponse added in v1.3.8 

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

func ParseGetBothResponse added in v1.3.4 

func ParseGetBothResponse(rsp *http.Response) (*GetBothResponse, error)

ParseGetBothResponse parses an HTTP response from a GetBothWithResponse call

func (GetBothResponse) Status added in v1.3.8 

func (r GetBothResponse) Status() string

Status returns HTTPResponse.Status

func (GetBothResponse) StatusCode added in v1.3.8 

func (r GetBothResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetJsonResponse added in v1.3.8 

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

func ParseGetJsonResponse added in v1.3.4 

func ParseGetJsonResponse(rsp *http.Response) (*GetJsonResponse, error)

ParseGetJsonResponse parses an HTTP response from a GetJsonWithResponse call

func (GetJsonResponse) Status added in v1.3.8 

func (r GetJsonResponse) Status() string

Status returns HTTPResponse.Status

func (GetJsonResponse) StatusCode added in v1.3.8 

func (r GetJsonResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetJsonWithTrailingSlashResponse added in v1.3.8 

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

func ParseGetJsonWithTrailingSlashResponse added in v1.3.4 

func ParseGetJsonWithTrailingSlashResponse(rsp *http.Response) (*GetJsonWithTrailingSlashResponse, error)

ParseGetJsonWithTrailingSlashResponse parses an HTTP response from a GetJsonWithTrailingSlashWithResponse call

func (GetJsonWithTrailingSlashResponse) Status added in v1.3.8 

func (r GetJsonWithTrailingSlashResponse) Status() string

Status returns HTTPResponse.Status

func (GetJsonWithTrailingSlashResponse) StatusCode added in v1.3.8 

func (r GetJsonWithTrailingSlashResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOtherResponse added in v1.3.8 

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

func ParseGetOtherResponse added in v1.3.4 

func ParseGetOtherResponse(rsp *http.Response) (*GetOtherResponse, error)

ParseGetOtherResponse parses an HTTP response from a GetOtherWithResponse call

func (GetOtherResponse) Status added in v1.3.8 

func (r GetOtherResponse) Status() string

Status returns HTTPResponse.Status

func (GetOtherResponse) StatusCode added in v1.3.8 

func (r GetOtherResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer added in v1.3.2 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type PostBothJSONRequestBody 

type PostBothJSONRequestBody = SchemaObject

PostBothJSONRequestBody defines body for PostBoth for application/json ContentType.

type PostBothResponse added in v1.3.8 

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

func ParsePostBothResponse added in v1.3.4 

func ParsePostBothResponse(rsp *http.Response) (*PostBothResponse, error)

ParsePostBothResponse parses an HTTP response from a PostBothWithResponse call

func (PostBothResponse) Status added in v1.3.8 

func (r PostBothResponse) Status() string

Status returns HTTPResponse.Status

func (PostBothResponse) StatusCode added in v1.3.8 

func (r PostBothResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostJsonJSONRequestBody 

type PostJsonJSONRequestBody = SchemaObject

PostJsonJSONRequestBody defines body for PostJson for application/json ContentType.

type PostJsonResponse added in v1.3.8 

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

func ParsePostJsonResponse added in v1.3.4 

func ParsePostJsonResponse(rsp *http.Response) (*PostJsonResponse, error)

ParsePostJsonResponse parses an HTTP response from a PostJsonWithResponse call

func (PostJsonResponse) Status added in v1.3.8 

func (r PostJsonResponse) Status() string

Status returns HTTPResponse.Status

func (PostJsonResponse) StatusCode added in v1.3.8 

func (r PostJsonResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostOtherResponse added in v1.3.8 

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

func ParsePostOtherResponse added in v1.3.4 

func ParsePostOtherResponse(rsp *http.Response) (*PostOtherResponse, error)

ParsePostOtherResponse parses an HTTP response from a PostOtherWithResponse call

func (PostOtherResponse) Status added in v1.3.8 

func (r PostOtherResponse) Status() string

Status returns HTTPResponse.Status

func (PostOtherResponse) StatusCode added in v1.3.8 

func (r PostOtherResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostVendorJsonApplicationVndAPIPlusJSONBody added in v1.13.2 

type PostVendorJsonApplicationVndAPIPlusJSONBody = map[string]interface{}

PostVendorJsonApplicationVndAPIPlusJSONBody defines parameters for PostVendorJson.

type PostVendorJsonApplicationVndAPIPlusJSONRequestBody added in v1.13.2 

type PostVendorJsonApplicationVndAPIPlusJSONRequestBody = PostVendorJsonApplicationVndAPIPlusJSONBody

PostVendorJsonApplicationVndAPIPlusJSONRequestBody defines body for PostVendorJson for application/vnd.api+json ContentType.

type PostVendorJsonResponse added in v1.12.0 

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

func ParsePostVendorJsonResponse added in v1.12.0 

func ParsePostVendorJsonResponse(rsp *http.Response) (*PostVendorJsonResponse, error)

ParsePostVendorJsonResponse parses an HTTP response from a PostVendorJsonWithResponse call

func (PostVendorJsonResponse) Status added in v1.12.0 

func (r PostVendorJsonResponse) Status() string

Status returns HTTPResponse.Status

func (PostVendorJsonResponse) StatusCode added in v1.12.0 

func (r PostVendorJsonResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn added in v1.2.4 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type SchemaObject 

type SchemaObject struct {
	FirstName string `json:"firstName"`
	Role      string `json:"role"`
}

SchemaObject defines model for SchemaObject.

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.