rounder

package
v0.0.0-...-e0b4b11 Latest Latest
Warning

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

Go to latest
Published: Oct 29, 2024 License: GPL-3.0 Imports: 13 Imported by: 0

Documentation

Overview

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

View Source
const (
	BasicAuthScopes = "basicAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewCreateRoundRequest

func NewCreateRoundRequest(server string, body CreateRoundJSONRequestBody) (*http.Request, error)

NewCreateRoundRequest calls the generic CreateRound builder with application/json body

func NewCreateRoundRequestWithBody

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

NewCreateRoundRequestWithBody generates requests for CreateRound with any type of body

func NewCreateUserRequest

func NewCreateUserRequest(server string, body CreateUserJSONRequestBody) (*http.Request, error)

NewCreateUserRequest calls the generic CreateUser builder with application/json body

func NewCreateUserRequestWithBody

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

NewCreateUserRequestWithBody generates requests for CreateUser with any type of body

func NewGetHoleStatsRequest

func NewGetHoleStatsRequest(server string, roundId PathRoundId, holeId PathHoleId) (*http.Request, error)

NewGetHoleStatsRequest generates requests for GetHoleStats

func NewGetLineChartAveragesRequest

func NewGetLineChartAveragesRequest(server string, params *GetLineChartAveragesParams) (*http.Request, error)

NewGetLineChartAveragesRequest generates requests for GetLineChartAverages

func NewGetNewRoundCoursesRequest

func NewGetNewRoundCoursesRequest(server string, params *GetNewRoundCoursesParams) (*http.Request, error)

NewGetNewRoundCoursesRequest generates requests for GetNewRoundCourses

func NewGetNewRoundMarkerRequest

func NewGetNewRoundMarkerRequest(server string, courseId PathCourseId) (*http.Request, error)

NewGetNewRoundMarkerRequest generates requests for GetNewRoundMarker

func NewGetPieChartAveragesRequest

func NewGetPieChartAveragesRequest(server string, params *GetPieChartAveragesParams) (*http.Request, error)

NewGetPieChartAveragesRequest generates requests for GetPieChartAverages

func NewGetRoundHolesRequest

func NewGetRoundHolesRequest(server string, roundId PathRoundId) (*http.Request, error)

NewGetRoundHolesRequest generates requests for GetRoundHoles

func NewGetRoundsRequest

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

NewGetRoundsRequest generates requests for GetRounds

func NewLoginRequest

func NewLoginRequest(server string, body LoginJSONRequestBody) (*http.Request, error)

NewLoginRequest calls the generic Login builder with application/json body

func NewLoginRequestWithBody

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

NewLoginRequestWithBody generates requests for Login with any type of body

func NewUpdateHoleStatsRequest

func NewUpdateHoleStatsRequest(server string, roundId PathRoundId, holeId PathHoleId, body UpdateHoleStatsJSONRequestBody) (*http.Request, error)

NewUpdateHoleStatsRequest calls the generic UpdateHoleStats builder with application/json body

func NewUpdateHoleStatsRequestWithBody

func NewUpdateHoleStatsRequestWithBody(server string, roundId PathRoundId, holeId PathHoleId, contentType string, body io.Reader) (*http.Request, error)

NewUpdateHoleStatsRequestWithBody generates requests for UpdateHoleStats with any type of body

func RegisterHandlers

func RegisterHandlers(router *mux.Router, si ServerInterface, opts ...ServerOption)

RegisterHandlers registers the api handlers.

func RegisterUnauthedHandlers

func RegisterUnauthedHandlers(router *mux.Router, si ServerInterface, opts ...ServerOption)

RegisterUnauthedHandlers registers any api handlers which do not have any authentication on them. Most services will not have any.

Types

type AverageType

type AverageType = string

AverageType defines the model for average_type.

const (
	AverageType_fairway_hit AverageType = "fairway_hit"
	AverageType_green_hit   AverageType = "green_hit"
	AverageType_par_3       AverageType = "par_3"
	AverageType_par_4       AverageType = "par_4"
	AverageType_par_5       AverageType = "par_5"
	AverageType_penalties   AverageType = "penalties"
	AverageType_putts       AverageType = "putts"
)

List of AverageType

type ChartDataPoint

type ChartDataPoint struct {
	// X The x-axis label
	X *string `json:"x,omitempty"`

	// Y The y-axis label
	Y *float32 `json:"y,omitempty"`
}

ChartDataPoint defines the model for chart_data_point.

type ChartDataResponse

type ChartDataResponse struct {
	Data  []ChartDataPoint `json:"data"`
	Total int64            `json:"total"`
}

ChartDataResponse defines the model for chart_data_response.

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

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

func (*Client) CreateRoundWithBody

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

func (*Client) CreateUser

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

func (*Client) CreateUserWithBody

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

func (*Client) GetHoleStats

func (c *Client) GetHoleStats(ctx context.Context, roundId PathRoundId, holeId PathHoleId, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetLineChartAverages

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

func (*Client) GetNewRoundCourses

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

func (*Client) GetNewRoundMarker

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

func (*Client) GetPieChartAverages

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

func (*Client) GetRoundHoles

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

func (*Client) GetRounds

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

func (*Client) Login

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

func (*Client) LoginWithBody

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

func (*Client) UpdateHoleStats

func (c *Client) UpdateHoleStats(ctx context.Context, roundId PathRoundId, holeId PathHoleId, body UpdateHoleStatsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateHoleStatsWithBody

func (c *Client) UpdateHoleStatsWithBody(ctx context.Context, roundId PathRoundId, holeId PathHoleId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

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

	Login(ctx context.Context, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	CreateRound(ctx context.Context, body CreateRoundJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetNewRoundCourses request
	GetNewRoundCourses(ctx context.Context, params *GetNewRoundCoursesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetNewRoundMarker request
	GetNewRoundMarker(ctx context.Context, courseId PathCourseId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLineChartAverages request
	GetLineChartAverages(ctx context.Context, params *GetLineChartAveragesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPieChartAverages request
	GetPieChartAverages(ctx context.Context, params *GetPieChartAveragesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRoundHoles request
	GetRoundHoles(ctx context.Context, roundId PathRoundId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHoleStats request
	GetHoleStats(ctx context.Context, roundId PathRoundId, holeId PathHoleId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateHoleStatsWithBody request with any body
	UpdateHoleStatsWithBody(ctx context.Context, roundId PathRoundId, holeId PathHoleId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateHoleStats(ctx context.Context, roundId PathRoundId, holeId PathHoleId, body UpdateHoleStatsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	CreateUser(ctx context.Context, body CreateUserJSONRequestBody, 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) CreateRoundWithBodyWithResponse

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

CreateRoundWithBodyWithResponse request with arbitrary body returning *CreateRoundResponse

func (*ClientWithResponses) CreateRoundWithResponse

func (c *ClientWithResponses) CreateRoundWithResponse(ctx context.Context, body CreateRoundJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRoundResponse, error)

func (*ClientWithResponses) CreateUserWithBodyWithResponse

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

CreateUserWithBodyWithResponse request with arbitrary body returning *CreateUserResponse

func (*ClientWithResponses) CreateUserWithResponse

func (c *ClientWithResponses) CreateUserWithResponse(ctx context.Context, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)

func (*ClientWithResponses) GetHoleStatsWithResponse

func (c *ClientWithResponses) GetHoleStatsWithResponse(ctx context.Context, roundId PathRoundId, holeId PathHoleId, reqEditors ...RequestEditorFn) (*GetHoleStatsResponse, error)

GetHoleStatsWithResponse request returning *GetHoleStatsResponse

func (*ClientWithResponses) GetLineChartAveragesWithResponse

func (c *ClientWithResponses) GetLineChartAveragesWithResponse(ctx context.Context, params *GetLineChartAveragesParams, reqEditors ...RequestEditorFn) (*GetLineChartAveragesResponse, error)

GetLineChartAveragesWithResponse request returning *GetLineChartAveragesResponse

func (*ClientWithResponses) GetNewRoundCoursesWithResponse

func (c *ClientWithResponses) GetNewRoundCoursesWithResponse(ctx context.Context, params *GetNewRoundCoursesParams, reqEditors ...RequestEditorFn) (*GetNewRoundCoursesResponse, error)

GetNewRoundCoursesWithResponse request returning *GetNewRoundCoursesResponse

func (*ClientWithResponses) GetNewRoundMarkerWithResponse

func (c *ClientWithResponses) GetNewRoundMarkerWithResponse(ctx context.Context, courseId PathCourseId, reqEditors ...RequestEditorFn) (*GetNewRoundMarkerResponse, error)

GetNewRoundMarkerWithResponse request returning *GetNewRoundMarkerResponse

func (*ClientWithResponses) GetPieChartAveragesWithResponse

func (c *ClientWithResponses) GetPieChartAveragesWithResponse(ctx context.Context, params *GetPieChartAveragesParams, reqEditors ...RequestEditorFn) (*GetPieChartAveragesResponse, error)

GetPieChartAveragesWithResponse request returning *GetPieChartAveragesResponse

func (*ClientWithResponses) GetRoundHolesWithResponse

func (c *ClientWithResponses) GetRoundHolesWithResponse(ctx context.Context, roundId PathRoundId, reqEditors ...RequestEditorFn) (*GetRoundHolesResponse, error)

GetRoundHolesWithResponse request returning *GetRoundHolesResponse

func (*ClientWithResponses) GetRoundsWithResponse

func (c *ClientWithResponses) GetRoundsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRoundsResponse, error)

GetRoundsWithResponse request returning *GetRoundsResponse

func (*ClientWithResponses) LoginWithBodyWithResponse

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

LoginWithBodyWithResponse request with arbitrary body returning *LoginResponse

func (*ClientWithResponses) LoginWithResponse

func (c *ClientWithResponses) LoginWithResponse(ctx context.Context, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*LoginResponse, error)

func (*ClientWithResponses) UpdateHoleStatsWithBodyWithResponse

func (c *ClientWithResponses) UpdateHoleStatsWithBodyWithResponse(ctx context.Context, roundId PathRoundId, holeId PathHoleId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateHoleStatsResponse, error)

UpdateHoleStatsWithBodyWithResponse request with arbitrary body returning *UpdateHoleStatsResponse

func (*ClientWithResponses) UpdateHoleStatsWithResponse

func (c *ClientWithResponses) UpdateHoleStatsWithResponse(ctx context.Context, roundId PathRoundId, holeId PathHoleId, body UpdateHoleStatsJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateHoleStatsResponse, error)

type ClientWithResponsesInterface

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

	LoginWithResponse(ctx context.Context, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*LoginResponse, error)

	// GetRoundsWithResponse request
	GetRoundsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRoundsResponse, error)

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

	CreateRoundWithResponse(ctx context.Context, body CreateRoundJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRoundResponse, error)

	// GetNewRoundCoursesWithResponse request
	GetNewRoundCoursesWithResponse(ctx context.Context, params *GetNewRoundCoursesParams, reqEditors ...RequestEditorFn) (*GetNewRoundCoursesResponse, error)

	// GetNewRoundMarkerWithResponse request
	GetNewRoundMarkerWithResponse(ctx context.Context, courseId PathCourseId, reqEditors ...RequestEditorFn) (*GetNewRoundMarkerResponse, error)

	// GetLineChartAveragesWithResponse request
	GetLineChartAveragesWithResponse(ctx context.Context, params *GetLineChartAveragesParams, reqEditors ...RequestEditorFn) (*GetLineChartAveragesResponse, error)

	// GetPieChartAveragesWithResponse request
	GetPieChartAveragesWithResponse(ctx context.Context, params *GetPieChartAveragesParams, reqEditors ...RequestEditorFn) (*GetPieChartAveragesResponse, error)

	// GetRoundHolesWithResponse request
	GetRoundHolesWithResponse(ctx context.Context, roundId PathRoundId, reqEditors ...RequestEditorFn) (*GetRoundHolesResponse, error)

	// GetHoleStatsWithResponse request
	GetHoleStatsWithResponse(ctx context.Context, roundId PathRoundId, holeId PathHoleId, reqEditors ...RequestEditorFn) (*GetHoleStatsResponse, error)

	// UpdateHoleStatsWithBodyWithResponse request with any body
	UpdateHoleStatsWithBodyWithResponse(ctx context.Context, roundId PathRoundId, holeId PathHoleId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateHoleStatsResponse, error)

	UpdateHoleStatsWithResponse(ctx context.Context, roundId PathRoundId, holeId PathHoleId, body UpdateHoleStatsJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateHoleStatsResponse, error)

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

	CreateUserWithResponse(ctx context.Context, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)
}

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

type Course

type Course struct {
	Details []CourseDetails `json:"details"`
	Id      int64           `json:"id"`
	Name    string          `json:"name"`
}

Course defines the model for course.

type CourseDetails

type CourseDetails struct {
	Holes            []Hole   `json:"holes"`
	Id               int64    `json:"id"`
	Marker           *string  `json:"marker,omitempty"`
	MetersBackNine   *int64   `json:"meters_back_nine,omitempty"`
	MetersFrontNine  *int64   `json:"meters_front_nine,omitempty"`
	MetersTotal      *int64   `json:"meters_total,omitempty"`
	ParBackNine      *int64   `json:"par_back_nine,omitempty"`
	ParFrontNine     *int64   `json:"par_front_nine,omitempty"`
	ParTotal         *int64   `json:"par_total,omitempty"`
	Rating           *float64 `json:"rating,omitempty"`
	Slope            *int64   `json:"slope,omitempty"`
	YardageBackNine  *int64   `json:"yardage_back_nine,omitempty"`
	YardageFrontNine *int64   `json:"yardage_front_nine,omitempty"`
	YardageTotal     *int64   `json:"yardage_total,omitempty"`
}

CourseDetails defines the model for course_details.

type CourseDetailsResponse

type CourseDetailsResponse struct {
	Details []CourseDetails `json:"details"`
	Total   int64           `json:"total"`
}

CourseDetailsResponse defines the model for course_details_response.

type CoursesResponse

type CoursesResponse struct {
	Courses []Course `json:"courses"`
	Total   int64    `json:"total"`
}

CoursesResponse defines the model for courses_response.

type CreateRoundJSONRequestBody

type CreateRoundJSONRequestBody = RoundCreate

CreateRoundJSONRequestBody defines body for CreateRound for application/json ContentType.

type CreateRoundResponse

type CreateRoundResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *Round
	JSON400      *externalRef0.ErrorMessage
	JSON404      *externalRef0.Message
	JSON500      *externalRef0.ErrorMessage
}

func ParseCreateRoundResponse

func ParseCreateRoundResponse(rsp *http.Response) (*CreateRoundResponse, error)

ParseCreateRoundResponse parses an HTTP response from a CreateRoundWithResponse call

func (CreateRoundResponse) Status

func (r CreateRoundResponse) Status() string

Status returns HTTPResponse.Status

func (CreateRoundResponse) StatusCode

func (r CreateRoundResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateUserJSONRequestBody

type CreateUserJSONRequestBody = User

CreateUserJSONRequestBody defines body for CreateUser for application/json ContentType.

type CreateUserResponse

type CreateUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *User
	JSON400      *externalRef0.ErrorMessage
	JSON404      *externalRef0.Message
	JSON500      *externalRef0.ErrorMessage
}

func ParseCreateUserResponse

func ParseCreateUserResponse(rsp *http.Response) (*CreateUserResponse, error)

ParseCreateUserResponse parses an HTTP response from a CreateUserWithResponse call

func (CreateUserResponse) Status

func (r CreateUserResponse) Status() string

Status returns HTTPResponse.Status

func (CreateUserResponse) StatusCode

func (r CreateUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ErrorHandlerFunc

type ErrorHandlerFunc = func(http.ResponseWriter, *http.Request, error)

type GetHoleStatsResponse

type GetHoleStatsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *HoleStats
	JSON400      *externalRef0.ErrorMessage
	JSON401      *externalRef0.Message
	JSON500      *externalRef0.ErrorMessage
}

func ParseGetHoleStatsResponse

func ParseGetHoleStatsResponse(rsp *http.Response) (*GetHoleStatsResponse, error)

ParseGetHoleStatsResponse parses an HTTP response from a GetHoleStatsWithResponse call

func (GetHoleStatsResponse) Status

func (r GetHoleStatsResponse) Status() string

Status returns HTTPResponse.Status

func (GetHoleStatsResponse) StatusCode

func (r GetHoleStatsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLineChartAveragesParams

type GetLineChartAveragesParams struct {
	// AverageType The type of average
	AverageType QueryAverageType `form:"average_type" json:"average_type"`

	// FromDate Filter by date, from date.
	FromDate *externalRef0.FromDate `form:"from_date,omitempty" json:"from_date,omitempty"`

	// Since Filter by the duration, since the current date. (E.g. 1d, 1w, 1m, 1y)
	Since *externalRef0.Since `form:"since,omitempty" json:"since,omitempty"`
}

GetLineChartAveragesParams defines parameters for GetLineChartAverages.

type GetLineChartAveragesResponse

type GetLineChartAveragesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ChartDataResponse
	JSON401      *externalRef0.Message
	JSON500      *externalRef0.ErrorMessage
}

func ParseGetLineChartAveragesResponse

func ParseGetLineChartAveragesResponse(rsp *http.Response) (*GetLineChartAveragesResponse, error)

ParseGetLineChartAveragesResponse parses an HTTP response from a GetLineChartAveragesWithResponse call

func (GetLineChartAveragesResponse) Status

Status returns HTTPResponse.Status

func (GetLineChartAveragesResponse) StatusCode

func (r GetLineChartAveragesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetNewRoundCoursesParams

type GetNewRoundCoursesParams struct {
	// Name The name of the club
	Name *QueryNameParam `form:"name,omitempty" json:"name,omitempty"`
}

GetNewRoundCoursesParams defines parameters for GetNewRoundCourses.

type GetNewRoundCoursesResponse

type GetNewRoundCoursesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CoursesResponse
	JSON400      *externalRef0.ErrorMessage
	JSON500      *externalRef0.ErrorMessage
}

func ParseGetNewRoundCoursesResponse

func ParseGetNewRoundCoursesResponse(rsp *http.Response) (*GetNewRoundCoursesResponse, error)

ParseGetNewRoundCoursesResponse parses an HTTP response from a GetNewRoundCoursesWithResponse call

func (GetNewRoundCoursesResponse) Status

Status returns HTTPResponse.Status

func (GetNewRoundCoursesResponse) StatusCode

func (r GetNewRoundCoursesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetNewRoundMarkerResponse

type GetNewRoundMarkerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CourseDetailsResponse
	JSON400      *externalRef0.ErrorMessage
	JSON500      *externalRef0.ErrorMessage
}

func ParseGetNewRoundMarkerResponse

func ParseGetNewRoundMarkerResponse(rsp *http.Response) (*GetNewRoundMarkerResponse, error)

ParseGetNewRoundMarkerResponse parses an HTTP response from a GetNewRoundMarkerWithResponse call

func (GetNewRoundMarkerResponse) Status

func (r GetNewRoundMarkerResponse) Status() string

Status returns HTTPResponse.Status

func (GetNewRoundMarkerResponse) StatusCode

func (r GetNewRoundMarkerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPieChartAveragesParams

type GetPieChartAveragesParams struct {
	// AverageType The type of average
	AverageType QueryAverageType `form:"average_type" json:"average_type"`
}

GetPieChartAveragesParams defines parameters for GetPieChartAverages.

type GetPieChartAveragesResponse

type GetPieChartAveragesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ChartDataResponse
	JSON401      *externalRef0.Message
	JSON500      *externalRef0.ErrorMessage
}

func ParseGetPieChartAveragesResponse

func ParseGetPieChartAveragesResponse(rsp *http.Response) (*GetPieChartAveragesResponse, error)

ParseGetPieChartAveragesResponse parses an HTTP response from a GetPieChartAveragesWithResponse call

func (GetPieChartAveragesResponse) Status

Status returns HTTPResponse.Status

func (GetPieChartAveragesResponse) StatusCode

func (r GetPieChartAveragesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRoundHolesResponse

type GetRoundHolesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *HolesResponse
	JSON401      *externalRef0.Message
	JSON500      *externalRef0.ErrorMessage
}

func ParseGetRoundHolesResponse

func ParseGetRoundHolesResponse(rsp *http.Response) (*GetRoundHolesResponse, error)

ParseGetRoundHolesResponse parses an HTTP response from a GetRoundHolesWithResponse call

func (GetRoundHolesResponse) Status

func (r GetRoundHolesResponse) Status() string

Status returns HTTPResponse.Status

func (GetRoundHolesResponse) StatusCode

func (r GetRoundHolesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRoundsResponse

type GetRoundsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *RoundsResponse
	JSON401      *externalRef0.Message
	JSON500      *externalRef0.ErrorMessage
}

func ParseGetRoundsResponse

func ParseGetRoundsResponse(rsp *http.Response) (*GetRoundsResponse, error)

ParseGetRoundsResponse parses an HTTP response from a GetRoundsWithResponse call

func (GetRoundsResponse) Status

func (r GetRoundsResponse) Status() string

Status returns HTTPResponse.Status

func (GetRoundsResponse) StatusCode

func (r GetRoundsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HitInRegulation

type HitInRegulation = string

HitInRegulation defines the model for hit_in_regulation.

const (
	HitInRegulation_hit            HitInRegulation = "hit"
	HitInRegulation_left           HitInRegulation = "left"
	HitInRegulation_long           HitInRegulation = "long"
	HitInRegulation_not_applicable HitInRegulation = "not_applicable"
	HitInRegulation_right          HitInRegulation = "right"
	HitInRegulation_short          HitInRegulation = "short"
)

List of HitInRegulation

type Hole

type Hole struct {
	Id          *int64 `json:"id,omitempty"`
	Meters      *int64 `json:"meters,omitempty"`
	Number      *int64 `json:"number,omitempty"`
	Par         *int64 `json:"par,omitempty"`
	StrokeIndex *int64 `json:"stroke_index,omitempty"`
	Yardage     *int64 `json:"yardage,omitempty"`
}

Hole defines the model for hole.

type HoleStats

type HoleStats struct {
	FairwayHit *HitInRegulation `json:"fairway_hit,omitempty"`
	GreenHit   *HitInRegulation `json:"green_hit,omitempty"`

	// Penalties The number of penalty strokes
	Penalties *int64 `json:"penalties,omitempty"`

	// PinLocation The pin position
	PinLocation *string `json:"pin_location,omitempty"`

	// Putts The number of putts
	Putts *int64 `json:"putts,omitempty"`

	// Score The number of strokes
	Score *int64 `json:"score,omitempty"`
}

HoleStats defines the model for hole_stats.

type HolesResponse

type HolesResponse struct {
	Holes []Hole `json:"holes"`
	Total int64  `json:"total"`
}

HolesResponse defines the model for holes_response.

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InvalidParamFormatError

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap

func (e *InvalidParamFormatError) Unwrap() error

type LoginJSONBody

type LoginJSONBody struct {
	// Password The password
	Password *string `json:"password,omitempty"`

	// Username The username
	Username *string `json:"username,omitempty"`
}

LoginJSONBody defines parameters for Login.

type LoginJSONRequestBody

type LoginJSONRequestBody LoginJSONBody

LoginJSONRequestBody defines body for Login for application/json ContentType.

type LoginResponse

type LoginResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Token
	JSON400      *externalRef0.ErrorMessage
	JSON401      *externalRef0.Message
	JSON500      *externalRef0.ErrorMessage
}

func ParseLoginResponse

func ParseLoginResponse(rsp *http.Response) (*LoginResponse, error)

ParseLoginResponse parses an HTTP response from a LoginWithResponse call

func (LoginResponse) Status

func (r LoginResponse) Status() string

Status returns HTTPResponse.Status

func (LoginResponse) StatusCode

func (r LoginResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MetricsMiddlewareFunc

type MetricsMiddlewareFunc = http.HandlerFunc

type PathCourseId

type PathCourseId = int64

PathCourseId defines the model for path_course_id.

type PathHoleId

type PathHoleId = int64

PathHoleId defines the model for path_hole_id.

type PathRoundId

type PathRoundId = int64

PathRoundId defines the model for path_round_id.

type QueryAverageType

type QueryAverageType = AverageType

QueryAverageType defines the model for query_average_type.

type QueryNameParam

type QueryNameParam = string

QueryNameParam defines the model for query_name_param.

type RateLimiterFunc

type RateLimiterFunc = func(http.ResponseWriter, *http.Request) error

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type RequiredHeaderError

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error

func (e *RequiredParamError) Error() string

type Round

type Round struct {
	// CourseName The course name
	CourseName *string `json:"course_name,omitempty"`

	// Id The round id
	Id *int64 `json:"id,omitempty"`

	// Marker The marker
	Marker *string `json:"marker,omitempty"`

	// TeeTime The tee time
	TeeTime *time.Time `json:"tee_time,omitempty"`
}

Round defines the model for round.

type RoundCreate

type RoundCreate struct {
	// CourseId The course id
	CourseId *int64 `json:"course_id,omitempty"`

	// Id The round id
	Id *int64 `json:"id,omitempty"`

	// MarkerId The marker id
	MarkerId *int64 `json:"marker_id,omitempty"`

	// TeeTime The tee time
	TeeTime *time.Time `json:"tee_time,omitempty"`
}

RoundCreate defines the model for round_create.

type RoundsResponse

type RoundsResponse struct {
	Rounds []Round `json:"rounds"`
	Total  int64   `json:"total"`
}

RoundsResponse defines the model for rounds_response.

type ServerInterface

type ServerInterface interface {
	// Login
	// (POST /login)
	Login(w http.ResponseWriter, r *http.Request)
	// Get rounds
	// (GET /rounds)
	GetRounds(w http.ResponseWriter, r *http.Request)
	// Create a round
	// (POST /rounds)
	CreateRound(w http.ResponseWriter, r *http.Request)
	// Get courses to start a round
	// (GET /rounds/new/courses)
	GetNewRoundCourses(w http.ResponseWriter, r *http.Request, params GetNewRoundCoursesParams)
	// Get the marker used for a round
	// (GET /rounds/new/marker/{course_id})
	GetNewRoundMarker(w http.ResponseWriter, r *http.Request, courseId PathCourseId)
	// Get the stats for all rounds
	// (GET /rounds/stats/charts/line/averages)
	GetLineChartAverages(w http.ResponseWriter, r *http.Request, params GetLineChartAveragesParams)
	// Get the stats for all rounds
	// (GET /rounds/stats/charts/pie/averages)
	GetPieChartAverages(w http.ResponseWriter, r *http.Request, params GetPieChartAveragesParams)
	// Get the holes for a round
	// (GET /rounds/{round_id}/holes)
	GetRoundHoles(w http.ResponseWriter, r *http.Request, roundId PathRoundId)
	// Get the stats for a hole
	// (GET /rounds/{round_id}/holes/{hole_id}/stats)
	GetHoleStats(w http.ResponseWriter, r *http.Request, roundId PathRoundId, holeId PathHoleId)
	// Update the stats for a hole
	// (POST /rounds/{round_id}/holes/{hole_id}/stats)
	UpdateHoleStats(w http.ResponseWriter, r *http.Request, roundId PathRoundId, holeId PathHoleId)
	// Create a user
	// (POST /users)
	CreateUser(w http.ResponseWriter, r *http.Request)
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	// contains filtered or unexported fields
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) CreateRound

func (siw *ServerInterfaceWrapper) CreateRound(w http.ResponseWriter, r *http.Request)

CreateRound operation middleware

func (*ServerInterfaceWrapper) CreateUser

func (siw *ServerInterfaceWrapper) CreateUser(w http.ResponseWriter, r *http.Request)

CreateUser operation middleware

func (*ServerInterfaceWrapper) GetHoleStats

func (siw *ServerInterfaceWrapper) GetHoleStats(w http.ResponseWriter, r *http.Request)

GetHoleStats operation middleware

func (*ServerInterfaceWrapper) GetLineChartAverages

func (siw *ServerInterfaceWrapper) GetLineChartAverages(w http.ResponseWriter, r *http.Request)

GetLineChartAverages operation middleware

func (*ServerInterfaceWrapper) GetNewRoundCourses

func (siw *ServerInterfaceWrapper) GetNewRoundCourses(w http.ResponseWriter, r *http.Request)

GetNewRoundCourses operation middleware

func (*ServerInterfaceWrapper) GetNewRoundMarker

func (siw *ServerInterfaceWrapper) GetNewRoundMarker(w http.ResponseWriter, r *http.Request)

GetNewRoundMarker operation middleware

func (*ServerInterfaceWrapper) GetPieChartAverages

func (siw *ServerInterfaceWrapper) GetPieChartAverages(w http.ResponseWriter, r *http.Request)

GetPieChartAverages operation middleware

func (*ServerInterfaceWrapper) GetRoundHoles

func (siw *ServerInterfaceWrapper) GetRoundHoles(w http.ResponseWriter, r *http.Request)

GetRoundHoles operation middleware

func (*ServerInterfaceWrapper) GetRounds

func (siw *ServerInterfaceWrapper) GetRounds(w http.ResponseWriter, r *http.Request)

GetRounds operation middleware

func (*ServerInterfaceWrapper) Login

Login operation middleware

func (*ServerInterfaceWrapper) UpdateHoleStats

func (siw *ServerInterfaceWrapper) UpdateHoleStats(w http.ResponseWriter, r *http.Request)

UpdateHoleStats operation middleware

type ServerOption

type ServerOption func(s *ServerInterfaceWrapper)

ServerOption represents an optional feature applied to the server.

func WithAuthorization

func WithAuthorization(authz ServerInterface) ServerOption

WithAuthorization applies the passed authorization middleware to the server.

func WithErrorHandlerFunc

func WithErrorHandlerFunc(errorHandlerFunc ErrorHandlerFunc) ServerOption

WithErrorHandlerFunc sets the error handler function for the server.

func WithMetricsMiddleware

func WithMetricsMiddleware(middleware MetricsMiddlewareFunc) ServerOption

WithMetricsMiddleware applies the metrics middleware to the server.

func WithRateLimiter

func WithRateLimiter(rateLimiter RateLimiterFunc) ServerOption

WithRateLimiter applies the rate limiter middleware to routes with x-global-rate-limit.

type Token

type Token struct {
	// Token The token
	Token *string `json:"token,omitempty"`
}

Token defines the model for token.

type TooManyValuesForParamError

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error

type UnescapedCookieParamError

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap

func (e *UnescapedCookieParamError) Unwrap() error

type UnmarshalingParamError

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap

func (e *UnmarshalingParamError) Unwrap() error

type UpdateHoleStatsJSONRequestBody

type UpdateHoleStatsJSONRequestBody = HoleStats

UpdateHoleStatsJSONRequestBody defines body for UpdateHoleStats for application/json ContentType.

type UpdateHoleStatsResponse

type UpdateHoleStatsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *HoleStats
	JSON400      *externalRef0.ErrorMessage
	JSON401      *externalRef0.Message
	JSON500      *externalRef0.ErrorMessage
}

func ParseUpdateHoleStatsResponse

func ParseUpdateHoleStatsResponse(rsp *http.Response) (*UpdateHoleStatsResponse, error)

ParseUpdateHoleStatsResponse parses an HTTP response from a UpdateHoleStatsWithResponse call

func (UpdateHoleStatsResponse) Status

func (r UpdateHoleStatsResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateHoleStatsResponse) StatusCode

func (r UpdateHoleStatsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type User

type User struct {
	// Id The user id
	Id *int64 `json:"id,omitempty"`

	// Name The name of the user
	Name *string `json:"name,omitempty"`

	// Password The password
	Password *string `json:"password,omitempty"`

	// Username The username
	Username *string `json:"username,omitempty"`
}

User defines the model for user.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL