oapi_client

package
v0.0.0-...-996d052 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2023 License: GPL-3.0 Imports: 10 Imported by: 0

Documentation

Overview

Package oapi_client 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

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCreateUpdatePropertyInfoByIdRequest 

func NewCreateUpdatePropertyInfoByIdRequest(server string, propertyId string, body CreateUpdatePropertyInfoByIdJSONRequestBody) (*http.Request, error)

NewCreateUpdatePropertyInfoByIdRequest calls the generic CreateUpdatePropertyInfoById builder with application/json body

func NewCreateUpdatePropertyInfoByIdRequestWithBody 

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

NewCreateUpdatePropertyInfoByIdRequestWithBody generates requests for CreateUpdatePropertyInfoById with any type of body

func NewGetPropertiesInfoRequest 

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

NewGetPropertiesInfoRequest generates requests for GetPropertiesInfo

func NewGetPropertyInfoByIdRequest 

func NewGetPropertyInfoByIdRequest(server string, propertyId string) (*http.Request, error)

NewGetPropertyInfoByIdRequest generates requests for GetPropertyInfoById

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

func (c *Client) CreateUpdatePropertyInfoById(ctx context.Context, propertyId string, body CreateUpdatePropertyInfoByIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateUpdatePropertyInfoByIdWithBody 

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

func (*Client) GetPropertiesInfo 

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

func (*Client) GetPropertyInfoById 

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

type ClientInterface 

type ClientInterface interface {
	// GetPropertiesInfo request
	GetPropertiesInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPropertyInfoById request
	GetPropertyInfoById(ctx context.Context, propertyId string, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	CreateUpdatePropertyInfoById(ctx context.Context, propertyId string, body CreateUpdatePropertyInfoByIdJSONRequestBody, 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) CreateUpdatePropertyInfoByIdWithBodyWithResponse 

func (c *ClientWithResponses) CreateUpdatePropertyInfoByIdWithBodyWithResponse(ctx context.Context, propertyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateUpdatePropertyInfoByIdResponse, error)

CreateUpdatePropertyInfoByIdWithBodyWithResponse request with arbitrary body returning *CreateUpdatePropertyInfoByIdResponse

func (*ClientWithResponses) CreateUpdatePropertyInfoByIdWithResponse 

func (c *ClientWithResponses) CreateUpdatePropertyInfoByIdWithResponse(ctx context.Context, propertyId string, body CreateUpdatePropertyInfoByIdJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateUpdatePropertyInfoByIdResponse, error)

func (*ClientWithResponses) GetPropertiesInfoWithResponse 

func (c *ClientWithResponses) GetPropertiesInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetPropertiesInfoResponse, error)

GetPropertiesInfoWithResponse request returning *GetPropertiesInfoResponse

func (*ClientWithResponses) GetPropertyInfoByIdWithResponse 

func (c *ClientWithResponses) GetPropertyInfoByIdWithResponse(ctx context.Context, propertyId string, reqEditors ...RequestEditorFn) (*GetPropertyInfoByIdResponse, error)

GetPropertyInfoByIdWithResponse request returning *GetPropertyInfoByIdResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetPropertiesInfo request
	GetPropertiesInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetPropertiesInfoResponse, error)

	// GetPropertyInfoById request
	GetPropertyInfoByIdWithResponse(ctx context.Context, propertyId string, reqEditors ...RequestEditorFn) (*GetPropertyInfoByIdResponse, error)

	// CreateUpdatePropertyInfoById request with any body
	CreateUpdatePropertyInfoByIdWithBodyWithResponse(ctx context.Context, propertyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateUpdatePropertyInfoByIdResponse, error)

	CreateUpdatePropertyInfoByIdWithResponse(ctx context.Context, propertyId string, body CreateUpdatePropertyInfoByIdJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateUpdatePropertyInfoByIdResponse, error)
}

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

type CreateUpdatePropertyInfoByIdResponse 

type CreateUpdatePropertyInfoByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PropertyInfoResponse
	JSON400      *GenericErrorResponse
	JSON500      *GenericErrorResponse
	JSON501      *GenericErrorResponse
}

func ParseCreateUpdatePropertyInfoByIdResponse 

func ParseCreateUpdatePropertyInfoByIdResponse(rsp *http.Response) (*CreateUpdatePropertyInfoByIdResponse, error)

ParseCreateUpdatePropertyInfoByIdResponse parses an HTTP response from a CreateUpdatePropertyInfoByIdWithResponse call

func (CreateUpdatePropertyInfoByIdResponse) Status 

func (r CreateUpdatePropertyInfoByIdResponse) Status() string

Status returns HTTPResponse.Status

func (CreateUpdatePropertyInfoByIdResponse) StatusCode 

func (r CreateUpdatePropertyInfoByIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPropertiesInfoResponse 

type GetPropertiesInfoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PropertiesInfoResponse
	JSON400      *GenericErrorResponse
	JSON500      *GenericErrorResponse
	JSON501      *GenericErrorResponse
}

func ParseGetPropertiesInfoResponse 

func ParseGetPropertiesInfoResponse(rsp *http.Response) (*GetPropertiesInfoResponse, error)

ParseGetPropertiesInfoResponse parses an HTTP response from a GetPropertiesInfoWithResponse call

func (GetPropertiesInfoResponse) Status 

func (r GetPropertiesInfoResponse) Status() string

Status returns HTTPResponse.Status

func (GetPropertiesInfoResponse) StatusCode 

func (r GetPropertiesInfoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPropertyInfoByIdResponse 

type GetPropertyInfoByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PropertyInfoResponse
	JSON400      *GenericErrorResponse
	JSON500      *GenericErrorResponse
	JSON501      *GenericErrorResponse
}

func ParseGetPropertyInfoByIdResponse 

func ParseGetPropertyInfoByIdResponse(rsp *http.Response) (*GetPropertyInfoByIdResponse, error)

ParseGetPropertyInfoByIdResponse parses an HTTP response from a GetPropertyInfoByIdWithResponse call

func (GetPropertyInfoByIdResponse) Status 

func (r GetPropertyInfoByIdResponse) Status() string

Status returns HTTPResponse.Status

func (GetPropertyInfoByIdResponse) StatusCode 

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

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.