categorywebclient

Documentation

Overview

Package categorywebclient provides primitives to interact the openapi HTTP API.

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

Package categorywebclient provides primitives to interact the openapi HTTP API.

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

Index

• func NewCreateCategoryRequest(server string, body CreateCategoryJSONRequestBody) (*http.Request, error)
• func NewCreateCategoryRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewGetCategoryCategoryIdRequest(server string, categoryId CategoryIdParameter) (*http.Request, error)
• type Category
• type CategoryIdParameter
• type Client
  • func NewClient(server string, opts ...ClientOption) (*Client, error)
  • func (c *Client) CreateCategory(ctx context.Context, body CreateCategoryJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) CreateCategoryWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) GetCategoryCategoryId(ctx context.Context, categoryId CategoryIdParameter, ...) (*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) CreateCategoryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*CreateCategoryResponse, error)
  • func (c *ClientWithResponses) CreateCategoryWithResponse(ctx context.Context, body CreateCategoryJSONRequestBody) (*CreateCategoryResponse, error)
  • func (c *ClientWithResponses) GetCategoryCategoryIdWithResponse(ctx context.Context, categoryId CategoryIdParameter) (*GetCategoryCategoryIdResponse, error)
• type ClientWithResponsesInterface
• type CreateCategoryJSONBody
• type CreateCategoryJSONRequestBody
• type CreateCategoryResponse
  • func ParseCreateCategoryResponse(rsp *http.Response) (*CreateCategoryResponse, error)
  • func (r CreateCategoryResponse) Status() string
  • func (r CreateCategoryResponse) StatusCode() int
• type GetCategoryByIdResponse
• type GetCategoryCategoryIdResponse
  • func ParseGetCategoryCategoryIdResponse(rsp *http.Response) (*GetCategoryCategoryIdResponse, error)
  • func (r GetCategoryCategoryIdResponse) Status() string
  • func (r GetCategoryCategoryIdResponse) StatusCode() int
• type HttpRequestDoer
• type RequestEditorFn

Functions

func NewCreateCategoryRequest

func NewCreateCategoryRequest(server string, body CreateCategoryJSONRequestBody) (*http.Request, error)

NewCreateCategoryRequest calls the generic CreateCategory builder with application/json body

func NewCreateCategoryRequestWithBody

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

NewCreateCategoryRequestWithBody generates requests for CreateCategory with any type of body

func NewGetCategoryCategoryIdRequest

func NewGetCategoryCategoryIdRequest(server string, categoryId CategoryIdParameter) (*http.Request, error)

NewGetCategoryCategoryIdRequest generates requests for GetCategoryCategoryId

Types

type Category

type Category struct {
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
}

Category defines model for Category.

type CategoryIdParameter

type CategoryIdParameter string

CategoryIdParameter defines model for CategoryIdParameter.

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

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

func (*Client) CreateCategoryWithBody

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

func (*Client) GetCategoryCategoryId

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

type ClientInterface

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

	CreateCategory(ctx context.Context, body CreateCategoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCategoryCategoryId request
	GetCategoryCategoryId(ctx context.Context, categoryId CategoryIdParameter, 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) CreateCategoryWithBodyWithResponse

func (c *ClientWithResponses) CreateCategoryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*CreateCategoryResponse, error)

CreateCategoryWithBodyWithResponse request with arbitrary body returning *CreateCategoryResponse

func (*ClientWithResponses) CreateCategoryWithResponse

func (c *ClientWithResponses) CreateCategoryWithResponse(ctx context.Context, body CreateCategoryJSONRequestBody) (*CreateCategoryResponse, error)

func (*ClientWithResponses) GetCategoryCategoryIdWithResponse

func (c *ClientWithResponses) GetCategoryCategoryIdWithResponse(ctx context.Context, categoryId CategoryIdParameter) (*GetCategoryCategoryIdResponse, error)

GetCategoryCategoryIdWithResponse request returning *GetCategoryCategoryIdResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// CreateCategory request  with any body
	CreateCategoryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*CreateCategoryResponse, error)

	CreateCategoryWithResponse(ctx context.Context, body CreateCategoryJSONRequestBody) (*CreateCategoryResponse, error)

	// GetCategoryCategoryId request
	GetCategoryCategoryIdWithResponse(ctx context.Context, categoryId CategoryIdParameter) (*GetCategoryCategoryIdResponse, error)
}

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

type CreateCategoryJSONBody

type CreateCategoryJSONBody Category

CreateCategoryJSONBody defines parameters for CreateCategory.

type CreateCategoryJSONRequestBody

type CreateCategoryJSONRequestBody CreateCategoryJSONBody

CreateCategoryJSONRequestBody defines body for CreateCategory for application/json ContentType.

type CreateCategoryResponse

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

func ParseCreateCategoryResponse

func ParseCreateCategoryResponse(rsp *http.Response) (*CreateCategoryResponse, error)

ParseCreateCategoryResponse parses an HTTP response from a CreateCategoryWithResponse call

func (CreateCategoryResponse) Status

func (r CreateCategoryResponse) Status() string

Status returns HTTPResponse.Status

func (CreateCategoryResponse) StatusCode

func (r CreateCategoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCategoryByIdResponse

type GetCategoryByIdResponse Category

GetCategoryByIdResponse defines model for GetCategoryByIdResponse.

type GetCategoryCategoryIdResponse

type GetCategoryCategoryIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Category
}

func ParseGetCategoryCategoryIdResponse

func ParseGetCategoryCategoryIdResponse(rsp *http.Response) (*GetCategoryCategoryIdResponse, error)

ParseGetCategoryCategoryIdResponse parses an HTTP response from a GetCategoryCategoryIdWithResponse call

func (GetCategoryCategoryIdResponse) Status

func (r GetCategoryCategoryIdResponse) Status() string

Status returns HTTPResponse.Status

func (GetCategoryCategoryIdResponse) StatusCode

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