client

package
v0.0.0-...-b9360c4 Latest Latest
Warning

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

Go to latest
Published: Dec 15, 2023 License: BSD-3-Clause Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildProjectPayload

func BuildProjectPayload(activityProjectID string, activityProjectPage string, activityProjectAuth string) (*activity.ProjectPayload, error)

BuildProjectPayload builds the payload for the activity project endpoint from CLI flags.

func BuildStationPayload

func BuildStationPayload(activityStationID string, activityStationPage string, activityStationAuth string) (*activity.StationPayload, error)

BuildStationPayload builds the payload for the activity station endpoint from CLI flags.

func DecodeProjectResponse

func DecodeProjectResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (interface{}, error)

DecodeProjectResponse returns a decoder for responses returned by the activity project endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeProjectResponse may return the following errors:

  • "unauthorized" (type *goa.ServiceError): http.StatusUnauthorized
  • "forbidden" (type *goa.ServiceError): http.StatusForbidden
  • "not-found" (type *goa.ServiceError): http.StatusNotFound
  • "bad-request" (type *goa.ServiceError): http.StatusBadRequest
  • error: internal error

func DecodeStationResponse

func DecodeStationResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (interface{}, error)

DecodeStationResponse returns a decoder for responses returned by the activity station endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeStationResponse may return the following errors:

  • "unauthorized" (type *goa.ServiceError): http.StatusUnauthorized
  • "forbidden" (type *goa.ServiceError): http.StatusForbidden
  • "not-found" (type *goa.ServiceError): http.StatusNotFound
  • "bad-request" (type *goa.ServiceError): http.StatusBadRequest
  • error: internal error

func EncodeProjectRequest

func EncodeProjectRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, interface{}) error

EncodeProjectRequest returns an encoder for requests sent to the activity project server.

func EncodeStationRequest

func EncodeStationRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, interface{}) error

EncodeStationRequest returns an encoder for requests sent to the activity station server.

func NewProjectActivityPageViewOK

func NewProjectActivityPageViewOK(body *ProjectResponseBody) *activityviews.ProjectActivityPageView

NewProjectActivityPageViewOK builds a "activity" service "project" endpoint result from a HTTP "OK" response.

func NewProjectBadRequest

func NewProjectBadRequest(body *ProjectBadRequestResponseBody) *goa.ServiceError

NewProjectBadRequest builds a activity service project endpoint bad-request error.

func NewProjectForbidden

func NewProjectForbidden(body *ProjectForbiddenResponseBody) *goa.ServiceError

NewProjectForbidden builds a activity service project endpoint forbidden error.

func NewProjectNotFound

func NewProjectNotFound(body *ProjectNotFoundResponseBody) *goa.ServiceError

NewProjectNotFound builds a activity service project endpoint not-found error.

func NewProjectUnauthorized

func NewProjectUnauthorized(body *ProjectUnauthorizedResponseBody) *goa.ServiceError

NewProjectUnauthorized builds a activity service project endpoint unauthorized error.

func NewStationActivityPageViewOK

func NewStationActivityPageViewOK(body *StationResponseBody) *activityviews.StationActivityPageView

NewStationActivityPageViewOK builds a "activity" service "station" endpoint result from a HTTP "OK" response.

func NewStationBadRequest

func NewStationBadRequest(body *StationBadRequestResponseBody) *goa.ServiceError

NewStationBadRequest builds a activity service station endpoint bad-request error.

func NewStationForbidden

func NewStationForbidden(body *StationForbiddenResponseBody) *goa.ServiceError

NewStationForbidden builds a activity service station endpoint forbidden error.

func NewStationNotFound

func NewStationNotFound(body *StationNotFoundResponseBody) *goa.ServiceError

NewStationNotFound builds a activity service station endpoint not-found error.

func NewStationUnauthorized

func NewStationUnauthorized(body *StationUnauthorizedResponseBody) *goa.ServiceError

NewStationUnauthorized builds a activity service station endpoint unauthorized error.

func ProjectActivityPath

func ProjectActivityPath(id int64) string

ProjectActivityPath returns the URL path to the activity service project HTTP endpoint.

func StationActivityPath

func StationActivityPath(id int64) string

StationActivityPath returns the URL path to the activity service station HTTP endpoint.

func ValidateActivityEntryCollectionResponseBody

func ValidateActivityEntryCollectionResponseBody(body ActivityEntryCollectionResponseBody) (err error)

ValidateActivityEntryCollectionResponseBody runs the validations defined on ActivityEntryCollectionResponseBody

func ValidateActivityEntryResponseBody

func ValidateActivityEntryResponseBody(body *ActivityEntryResponseBody) (err error)

ValidateActivityEntryResponseBody runs the validations defined on ActivityEntryResponseBody

func ValidateProjectBadRequestResponseBody

func ValidateProjectBadRequestResponseBody(body *ProjectBadRequestResponseBody) (err error)

ValidateProjectBadRequestResponseBody runs the validations defined on project_bad-request_response_body

func ValidateProjectForbiddenResponseBody

func ValidateProjectForbiddenResponseBody(body *ProjectForbiddenResponseBody) (err error)

ValidateProjectForbiddenResponseBody runs the validations defined on project_forbidden_response_body

func ValidateProjectNotFoundResponseBody

func ValidateProjectNotFoundResponseBody(body *ProjectNotFoundResponseBody) (err error)

ValidateProjectNotFoundResponseBody runs the validations defined on project_not-found_response_body

func ValidateProjectSummaryResponseBody

func ValidateProjectSummaryResponseBody(body *ProjectSummaryResponseBody) (err error)

ValidateProjectSummaryResponseBody runs the validations defined on ProjectSummaryResponseBody

func ValidateProjectUnauthorizedResponseBody

func ValidateProjectUnauthorizedResponseBody(body *ProjectUnauthorizedResponseBody) (err error)

ValidateProjectUnauthorizedResponseBody runs the validations defined on project_unauthorized_response_body

func ValidateStationBadRequestResponseBody

func ValidateStationBadRequestResponseBody(body *StationBadRequestResponseBody) (err error)

ValidateStationBadRequestResponseBody runs the validations defined on station_bad-request_response_body

func ValidateStationForbiddenResponseBody

func ValidateStationForbiddenResponseBody(body *StationForbiddenResponseBody) (err error)

ValidateStationForbiddenResponseBody runs the validations defined on station_forbidden_response_body

func ValidateStationNotFoundResponseBody

func ValidateStationNotFoundResponseBody(body *StationNotFoundResponseBody) (err error)

ValidateStationNotFoundResponseBody runs the validations defined on station_not-found_response_body

func ValidateStationSummaryResponseBody

func ValidateStationSummaryResponseBody(body *StationSummaryResponseBody) (err error)

ValidateStationSummaryResponseBody runs the validations defined on StationSummaryResponseBody

func ValidateStationUnauthorizedResponseBody

func ValidateStationUnauthorizedResponseBody(body *StationUnauthorizedResponseBody) (err error)

ValidateStationUnauthorizedResponseBody runs the validations defined on station_unauthorized_response_body

Types

type ActivityEntryCollectionResponseBody

type ActivityEntryCollectionResponseBody []*ActivityEntryResponseBody

ActivityEntryCollectionResponseBody is used to define fields on response body types.

type ActivityEntryResponseBody

type ActivityEntryResponseBody struct {
	ID        *int64                      `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	Key       *string                     `form:"key,omitempty" json:"key,omitempty" xml:"key,omitempty"`
	Project   *ProjectSummaryResponseBody `form:"project,omitempty" json:"project,omitempty" xml:"project,omitempty"`
	Station   *StationSummaryResponseBody `form:"station,omitempty" json:"station,omitempty" xml:"station,omitempty"`
	CreatedAt *int64                      `form:"created_at,omitempty" json:"created_at,omitempty" xml:"created_at,omitempty"`
	Type      *string                     `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	Meta      interface{}                 `form:"meta,omitempty" json:"meta,omitempty" xml:"meta,omitempty"`
}

ActivityEntryResponseBody is used to define fields on response body types.

type Client

type Client struct {
	// Station Doer is the HTTP client used to make requests to the station
	// endpoint.
	StationDoer goahttp.Doer

	// Project Doer is the HTTP client used to make requests to the project
	// endpoint.
	ProjectDoer goahttp.Doer

	// CORS Doer is the HTTP client used to make requests to the  endpoint.
	CORSDoer goahttp.Doer

	// RestoreResponseBody controls whether the response bodies are reset after
	// decoding so they can be read again.
	RestoreResponseBody bool
	// contains filtered or unexported fields
}

Client lists the activity service endpoint HTTP clients.

func NewClient

func NewClient(
	scheme string,
	host string,
	doer goahttp.Doer,
	enc func(*http.Request) goahttp.Encoder,
	dec func(*http.Response) goahttp.Decoder,
	restoreBody bool,
) *Client

NewClient instantiates HTTP clients for all the activity service servers.

func (*Client) BuildProjectRequest

func (c *Client) BuildProjectRequest(ctx context.Context, v interface{}) (*http.Request, error)

BuildProjectRequest instantiates a HTTP request object with method and path set to call the "activity" service "project" endpoint

func (*Client) BuildStationRequest

func (c *Client) BuildStationRequest(ctx context.Context, v interface{}) (*http.Request, error)

BuildStationRequest instantiates a HTTP request object with method and path set to call the "activity" service "station" endpoint

func (*Client) Project

func (c *Client) Project() goa.Endpoint

Project returns an endpoint that makes HTTP requests to the activity service project server.

func (*Client) Station

func (c *Client) Station() goa.Endpoint

Station returns an endpoint that makes HTTP requests to the activity service station server.

type ProjectBadRequestResponseBody

type ProjectBadRequestResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

ProjectBadRequestResponseBody is the type of the "activity" service "project" endpoint HTTP response body for the "bad-request" error.

type ProjectForbiddenResponseBody

type ProjectForbiddenResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

ProjectForbiddenResponseBody is the type of the "activity" service "project" endpoint HTTP response body for the "forbidden" error.

type ProjectNotFoundResponseBody

type ProjectNotFoundResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

ProjectNotFoundResponseBody is the type of the "activity" service "project" endpoint HTTP response body for the "not-found" error.

type ProjectResponseBody

type ProjectResponseBody struct {
	Activities ActivityEntryCollectionResponseBody `form:"activities,omitempty" json:"activities,omitempty" xml:"activities,omitempty"`
	Total      *int32                              `form:"total,omitempty" json:"total,omitempty" xml:"total,omitempty"`
	Page       *int32                              `form:"page,omitempty" json:"page,omitempty" xml:"page,omitempty"`
}

ProjectResponseBody is the type of the "activity" service "project" endpoint HTTP response body.

type ProjectSummaryResponseBody

type ProjectSummaryResponseBody struct {
	ID   *int64  `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
}

ProjectSummaryResponseBody is used to define fields on response body types.

type ProjectUnauthorizedResponseBody

type ProjectUnauthorizedResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

ProjectUnauthorizedResponseBody is the type of the "activity" service "project" endpoint HTTP response body for the "unauthorized" error.

type StationBadRequestResponseBody

type StationBadRequestResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

StationBadRequestResponseBody is the type of the "activity" service "station" endpoint HTTP response body for the "bad-request" error.

type StationForbiddenResponseBody

type StationForbiddenResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

StationForbiddenResponseBody is the type of the "activity" service "station" endpoint HTTP response body for the "forbidden" error.

type StationNotFoundResponseBody

type StationNotFoundResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

StationNotFoundResponseBody is the type of the "activity" service "station" endpoint HTTP response body for the "not-found" error.

type StationResponseBody

type StationResponseBody struct {
	Activities ActivityEntryCollectionResponseBody `form:"activities,omitempty" json:"activities,omitempty" xml:"activities,omitempty"`
	Total      *int32                              `form:"total,omitempty" json:"total,omitempty" xml:"total,omitempty"`
	Page       *int32                              `form:"page,omitempty" json:"page,omitempty" xml:"page,omitempty"`
}

StationResponseBody is the type of the "activity" service "station" endpoint HTTP response body.

type StationSummaryResponseBody

type StationSummaryResponseBody struct {
	ID   *int64  `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
}

StationSummaryResponseBody is used to define fields on response body types.

type StationUnauthorizedResponseBody

type StationUnauthorizedResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

StationUnauthorizedResponseBody is the type of the "activity" service "station" endpoint HTTP response body for the "unauthorized" error.

Jump to

Keyboard shortcuts

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