Documentation
¶
Overview ¶
Package billingapi provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.12.4 DO NOT EDIT.
Package billingapi 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
- func NewDeleteStripeInfoRequest(server string) (*http.Request, error)
- func NewGetStripeInfoRequest(server string) (*http.Request, error)
- func NewReturnInternalServerErrorRequest(server string) (*http.Request, error)
- func NewUpdateStripeInfoRequest(server string, body UpdateStripeInfoJSONRequestBody) (*http.Request, error)
- func NewUpdateStripeInfoRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- type Client
- func (c *Client) DeleteStripeInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetStripeInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ReturnInternalServerError(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) UpdateStripeInfo(ctx context.Context, body UpdateStripeInfoJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpdateStripeInfoWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) DeleteStripeInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*DeleteStripeInfoResponse, error)
- func (c *ClientWithResponses) GetStripeInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetStripeInfoResponse, error)
- func (c *ClientWithResponses) ReturnInternalServerErrorWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ReturnInternalServerErrorResponse, error)
- func (c *ClientWithResponses) UpdateStripeInfoWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*UpdateStripeInfoResponse, error)
- func (c *ClientWithResponses) UpdateStripeInfoWithResponse(ctx context.Context, body UpdateStripeInfoJSONRequestBody, ...) (*UpdateStripeInfoResponse, error)
- type ClientWithResponsesInterface
- type DeleteStripeInfoResponse
- type Error
- type GetStripeInfoResponse
- type HttpRequestDoer
- type RequestEditorFn
- type ReturnInternalServerErrorResponse
- type StripeInfo
- type UpdateStripeInfoJSONRequestBody
- type UpdateStripeInfoParam
- type UpdateStripeInfoResponse
Constants ¶
const (
BearerScopes = "Bearer.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func NewDeleteStripeInfoRequest ¶
NewDeleteStripeInfoRequest generates requests for DeleteStripeInfo
func NewGetStripeInfoRequest ¶
NewGetStripeInfoRequest generates requests for GetStripeInfo
func NewReturnInternalServerErrorRequest ¶
NewReturnInternalServerErrorRequest generates requests for ReturnInternalServerError
func NewUpdateStripeInfoRequest ¶
func NewUpdateStripeInfoRequest(server string, body UpdateStripeInfoJSONRequestBody) (*http.Request, error)
NewUpdateStripeInfoRequest calls the generic UpdateStripeInfo builder with application/json 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) DeleteStripeInfo ¶
func (*Client) GetStripeInfo ¶
func (*Client) ReturnInternalServerError ¶
func (*Client) UpdateStripeInfo ¶
func (c *Client) UpdateStripeInfo(ctx context.Context, body UpdateStripeInfoJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
type ClientInterface ¶
type ClientInterface interface {
// ReturnInternalServerError request
ReturnInternalServerError(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteStripeInfo request
DeleteStripeInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetStripeInfo request
GetStripeInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateStripeInfo request with any body
UpdateStripeInfoWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateStripeInfo(ctx context.Context, body UpdateStripeInfoJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
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) DeleteStripeInfoWithResponse ¶
func (c *ClientWithResponses) DeleteStripeInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*DeleteStripeInfoResponse, error)
DeleteStripeInfoWithResponse request returning *DeleteStripeInfoResponse
func (*ClientWithResponses) GetStripeInfoWithResponse ¶
func (c *ClientWithResponses) GetStripeInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetStripeInfoResponse, error)
GetStripeInfoWithResponse request returning *GetStripeInfoResponse
func (*ClientWithResponses) ReturnInternalServerErrorWithResponse ¶
func (c *ClientWithResponses) ReturnInternalServerErrorWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ReturnInternalServerErrorResponse, error)
ReturnInternalServerErrorWithResponse request returning *ReturnInternalServerErrorResponse
func (*ClientWithResponses) UpdateStripeInfoWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateStripeInfoWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateStripeInfoResponse, error)
UpdateStripeInfoWithBodyWithResponse request with arbitrary body returning *UpdateStripeInfoResponse
func (*ClientWithResponses) UpdateStripeInfoWithResponse ¶
func (c *ClientWithResponses) UpdateStripeInfoWithResponse(ctx context.Context, body UpdateStripeInfoJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateStripeInfoResponse, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// ReturnInternalServerError request
ReturnInternalServerErrorWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ReturnInternalServerErrorResponse, error)
// DeleteStripeInfo request
DeleteStripeInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*DeleteStripeInfoResponse, error)
// GetStripeInfo request
GetStripeInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetStripeInfoResponse, error)
// UpdateStripeInfo request with any body
UpdateStripeInfoWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateStripeInfoResponse, error)
UpdateStripeInfoWithResponse(ctx context.Context, body UpdateStripeInfoJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateStripeInfoResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type DeleteStripeInfoResponse ¶
func ParseDeleteStripeInfoResponse ¶
func ParseDeleteStripeInfoResponse(rsp *http.Response) (*DeleteStripeInfoResponse, error)
ParseDeleteStripeInfoResponse parses an HTTP response from a DeleteStripeInfoWithResponse call
func (DeleteStripeInfoResponse) Status ¶
func (r DeleteStripeInfoResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteStripeInfoResponse) StatusCode ¶
func (r DeleteStripeInfoResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Error ¶
type Error struct {
// Message Error message
Message string `json:"message"`
// Type permission_denied
Type string `json:"type"`
}
Error defines model for Error.
type GetStripeInfoResponse ¶
type GetStripeInfoResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *StripeInfo
JSON500 *Error
}
func ParseGetStripeInfoResponse ¶
func ParseGetStripeInfoResponse(rsp *http.Response) (*GetStripeInfoResponse, error)
ParseGetStripeInfoResponse parses an HTTP response from a GetStripeInfoWithResponse call
func (GetStripeInfoResponse) Status ¶
func (r GetStripeInfoResponse) Status() string
Status returns HTTPResponse.Status
func (GetStripeInfoResponse) StatusCode ¶
func (r GetStripeInfoResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type ReturnInternalServerErrorResponse ¶
type ReturnInternalServerErrorResponse struct {
Body []byte
HTTPResponse *http.Response
JSON500 *Error
}
func ParseReturnInternalServerErrorResponse ¶
func ParseReturnInternalServerErrorResponse(rsp *http.Response) (*ReturnInternalServerErrorResponse, error)
ParseReturnInternalServerErrorResponse parses an HTTP response from a ReturnInternalServerErrorWithResponse call
func (ReturnInternalServerErrorResponse) Status ¶
func (r ReturnInternalServerErrorResponse) Status() string
Status returns HTTPResponse.Status
func (ReturnInternalServerErrorResponse) StatusCode ¶
func (r ReturnInternalServerErrorResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type StripeInfo ¶
type StripeInfo struct {
IsRegistered bool `json:"is_registered"`
}
StripeInfo defines model for StripeInfo.
type UpdateStripeInfoJSONRequestBody ¶
type UpdateStripeInfoJSONRequestBody = UpdateStripeInfoParam
UpdateStripeInfoJSONRequestBody defines body for UpdateStripeInfo for application/json ContentType.
type UpdateStripeInfoParam ¶
type UpdateStripeInfoParam struct {
// SecretKey secret key
SecretKey string `json:"secret_key"`
}
UpdateStripeInfoParam defines model for UpdateStripeInfoParam.
type UpdateStripeInfoResponse ¶
func ParseUpdateStripeInfoResponse ¶
func ParseUpdateStripeInfoResponse(rsp *http.Response) (*UpdateStripeInfoResponse, error)
ParseUpdateStripeInfoResponse parses an HTTP response from a UpdateStripeInfoWithResponse call
func (UpdateStripeInfoResponse) Status ¶
func (r UpdateStripeInfoResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateStripeInfoResponse) StatusCode ¶
func (r UpdateStripeInfoResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode