client

package
v0.25.0 Latest Latest
Warning

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

 Go to latest Published: May 14, 2023 License: Apache-2.0 Imports: 13 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildCreatePayload 

func BuildCreatePayload(orderCreateBody string, orderCreateJWT string) (*order.CreatePayload, error)

BuildCreatePayload builds the payload for the order create endpoint from CLI flags.

func BuildListPayload 

func BuildListPayload(orderListLimit string, orderListPage string, orderListFilter string, orderListOrderBy string, orderListOrderDesc string, orderListAtTime string, orderListJWT string) (*order.ListPayload, error)

BuildListPayload builds the payload for the order list endpoint from CLI flags.

func BuildReadPayload 

func BuildReadPayload(orderReadID string, orderReadJWT string) (*order.ReadPayload, error)

BuildReadPayload builds the payload for the order read endpoint from CLI flags.

func CreateOrderPath 

func CreateOrderPath() string

CreateOrderPath returns the URL path to the order service create HTTP endpoint.

func DecodeCreateResponse 

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

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

  • "bad-request" (type *order.BadRequestT): http.StatusBadRequest
  • "invalid-credential" (type *order.InvalidCredentialsT): http.StatusBadRequest
  • "invalid-parameter" (type *order.InvalidParameterValue): http.StatusUnprocessableEntity
  • "invalid-scopes" (type *order.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *order.NotImplementedT): http.StatusNotImplemented
  • "not-found" (type *order.ResourceNotFoundT): http.StatusNotFound
  • "not-available" (type *order.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *order.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func DecodeListResponse 

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

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

  • "bad-request" (type *order.BadRequestT): http.StatusBadRequest
  • "invalid-credential" (type *order.InvalidCredentialsT): http.StatusBadRequest
  • "invalid-parameter" (type *order.InvalidParameterValue): http.StatusUnprocessableEntity
  • "invalid-scopes" (type *order.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *order.NotImplementedT): http.StatusNotImplemented
  • "not-authorized" (type *order.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func DecodeReadResponse 

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

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

  • "bad-request" (type *order.BadRequestT): http.StatusBadRequest
  • "invalid-credential" (type *order.InvalidCredentialsT): http.StatusBadRequest
  • "invalid-scopes" (type *order.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *order.NotImplementedT): http.StatusNotImplemented
  • "not-found" (type *order.ResourceNotFoundT): http.StatusNotFound
  • "not-authorized" (type *order.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func EncodeCreateRequest 

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

EncodeCreateRequest returns an encoder for requests sent to the order create server.

func EncodeListRequest 

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

EncodeListRequest returns an encoder for requests sent to the order list server.

func EncodeReadRequest 

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

EncodeReadRequest returns an encoder for requests sent to the order read server.

func ListOrderPath 

func ListOrderPath() string

ListOrderPath returns the URL path to the order service list HTTP endpoint.

func NewCreateBadRequest 

func NewCreateBadRequest(body *CreateBadRequestResponseBody) *order.BadRequestT

NewCreateBadRequest builds a order service create endpoint bad-request error.

func NewCreateInvalidCredential 

func NewCreateInvalidCredential() *order.InvalidCredentialsT

NewCreateInvalidCredential builds a order service create endpoint invalid-credential error.

func NewCreateInvalidParameter 

func NewCreateInvalidParameter(body *CreateInvalidParameterResponseBody) *order.InvalidParameterValue

NewCreateInvalidParameter builds a order service create endpoint invalid-parameter error.

func NewCreateInvalidScopes 

func NewCreateInvalidScopes(body *CreateInvalidScopesResponseBody) *order.InvalidScopesT

NewCreateInvalidScopes builds a order service create endpoint invalid-scopes error.

func NewCreateNotAuthorized 

func NewCreateNotAuthorized() *order.UnauthorizedT

NewCreateNotAuthorized builds a order service create endpoint not-authorized error.

func NewCreateNotAvailable 

func NewCreateNotAvailable() *order.ServiceNotAvailableT

NewCreateNotAvailable builds a order service create endpoint not-available error.

func NewCreateNotFound 

func NewCreateNotFound(body *CreateNotFoundResponseBody) *order.ResourceNotFoundT

NewCreateNotFound builds a order service create endpoint not-found error.

func NewCreateNotImplemented 

func NewCreateNotImplemented(body *CreateNotImplementedResponseBody) *order.NotImplementedT

NewCreateNotImplemented builds a order service create endpoint not-implemented error.

func NewCreateOrderStatusRTOK 

func NewCreateOrderStatusRTOK(body *CreateResponseBody) *orderviews.OrderStatusRTView

NewCreateOrderStatusRTOK builds a "order" service "create" endpoint result from a HTTP "OK" response.

func NewListBadRequest 

func NewListBadRequest(body *ListBadRequestResponseBody) *order.BadRequestT

NewListBadRequest builds a order service list endpoint bad-request error.

func NewListInvalidCredential 

func NewListInvalidCredential() *order.InvalidCredentialsT

NewListInvalidCredential builds a order service list endpoint invalid-credential error.

func NewListInvalidParameter added in v0.25.0 

func NewListInvalidParameter(body *ListInvalidParameterResponseBody) *order.InvalidParameterValue

NewListInvalidParameter builds a order service list endpoint invalid-parameter error.

func NewListInvalidScopes 

func NewListInvalidScopes(body *ListInvalidScopesResponseBody) *order.InvalidScopesT

NewListInvalidScopes builds a order service list endpoint invalid-scopes error.

func NewListNotAuthorized 

func NewListNotAuthorized() *order.UnauthorizedT

NewListNotAuthorized builds a order service list endpoint not-authorized error.

func NewListNotImplemented 

func NewListNotImplemented(body *ListNotImplementedResponseBody) *order.NotImplementedT

NewListNotImplemented builds a order service list endpoint not-implemented error.

func NewListOrderListRTOK 

func NewListOrderListRTOK(body *ListResponseBody) *orderviews.OrderListRTView

NewListOrderListRTOK builds a "order" service "list" endpoint result from a HTTP "OK" response.

func NewReadBadRequest 

func NewReadBadRequest(body *ReadBadRequestResponseBody) *order.BadRequestT

NewReadBadRequest builds a order service read endpoint bad-request error.

func NewReadInvalidCredential 

func NewReadInvalidCredential() *order.InvalidCredentialsT

NewReadInvalidCredential builds a order service read endpoint invalid-credential error.

func NewReadInvalidScopes 

func NewReadInvalidScopes(body *ReadInvalidScopesResponseBody) *order.InvalidScopesT

NewReadInvalidScopes builds a order service read endpoint invalid-scopes error.

func NewReadNotAuthorized 

func NewReadNotAuthorized() *order.UnauthorizedT

NewReadNotAuthorized builds a order service read endpoint not-authorized error.

func NewReadNotFound 

func NewReadNotFound(body *ReadNotFoundResponseBody) *order.ResourceNotFoundT

NewReadNotFound builds a order service read endpoint not-found error.

func NewReadNotImplemented 

func NewReadNotImplemented(body *ReadNotImplementedResponseBody) *order.NotImplementedT

NewReadNotImplemented builds a order service read endpoint not-implemented error.

func NewReadOrderStatusRTOK 

func NewReadOrderStatusRTOK(body *ReadResponseBody) *orderviews.OrderStatusRTView

NewReadOrderStatusRTOK builds a "order" service "read" endpoint result from a HTTP "OK" response.

func ReadOrderPath 

func ReadOrderPath(id string) string

ReadOrderPath returns the URL path to the order service read HTTP endpoint.

func ValidateCreateBadRequestResponseBody 

func ValidateCreateBadRequestResponseBody(body *CreateBadRequestResponseBody) (err error)

ValidateCreateBadRequestResponseBody runs the validations defined on create_bad-request_response_body

func ValidateCreateInvalidParameterResponseBody 

func ValidateCreateInvalidParameterResponseBody(body *CreateInvalidParameterResponseBody) (err error)

ValidateCreateInvalidParameterResponseBody runs the validations defined on create_invalid-parameter_response_body

func ValidateCreateInvalidScopesResponseBody 

func ValidateCreateInvalidScopesResponseBody(body *CreateInvalidScopesResponseBody) (err error)

ValidateCreateInvalidScopesResponseBody runs the validations defined on create_invalid-scopes_response_body

func ValidateCreateNotFoundResponseBody 

func ValidateCreateNotFoundResponseBody(body *CreateNotFoundResponseBody) (err error)

ValidateCreateNotFoundResponseBody runs the validations defined on create_not-found_response_body

func ValidateCreateNotImplementedResponseBody 

func ValidateCreateNotImplementedResponseBody(body *CreateNotImplementedResponseBody) (err error)

ValidateCreateNotImplementedResponseBody runs the validations defined on create_not-implemented_response_body

func ValidateDescribedByTResponseBody 

func ValidateDescribedByTResponseBody(body *DescribedByTResponseBody) (err error)

ValidateDescribedByTResponseBody runs the validations defined on DescribedByTResponseBody

func ValidateListBadRequestResponseBody 

func ValidateListBadRequestResponseBody(body *ListBadRequestResponseBody) (err error)

ValidateListBadRequestResponseBody runs the validations defined on list_bad-request_response_body

func ValidateListInvalidParameterResponseBody added in v0.25.0 

func ValidateListInvalidParameterResponseBody(body *ListInvalidParameterResponseBody) (err error)

ValidateListInvalidParameterResponseBody runs the validations defined on list_invalid-parameter_response_body

func ValidateListInvalidScopesResponseBody 

func ValidateListInvalidScopesResponseBody(body *ListInvalidScopesResponseBody) (err error)

ValidateListInvalidScopesResponseBody runs the validations defined on list_invalid-scopes_response_body

func ValidateListNotImplementedResponseBody 

func ValidateListNotImplementedResponseBody(body *ListNotImplementedResponseBody) (err error)

ValidateListNotImplementedResponseBody runs the validations defined on list_not-implemented_response_body

func ValidateNavTResponseBody 

func ValidateNavTResponseBody(body *NavTResponseBody) (err error)

ValidateNavTResponseBody runs the validations defined on NavTResponseBody

func ValidateOrderListItemResponseBody 

func ValidateOrderListItemResponseBody(body *OrderListItemResponseBody) (err error)

ValidateOrderListItemResponseBody runs the validations defined on OrderListItemResponseBody

func ValidateProductTResponseBody 

func ValidateProductTResponseBody(body *ProductTResponseBody) (err error)

ValidateProductTResponseBody runs the validations defined on ProductTResponseBody

func ValidateReadBadRequestResponseBody 

func ValidateReadBadRequestResponseBody(body *ReadBadRequestResponseBody) (err error)

ValidateReadBadRequestResponseBody runs the validations defined on read_bad-request_response_body

func ValidateReadInvalidScopesResponseBody 

func ValidateReadInvalidScopesResponseBody(body *ReadInvalidScopesResponseBody) (err error)

ValidateReadInvalidScopesResponseBody runs the validations defined on read_invalid-scopes_response_body

func ValidateReadNotFoundResponseBody 

func ValidateReadNotFoundResponseBody(body *ReadNotFoundResponseBody) (err error)

ValidateReadNotFoundResponseBody runs the validations defined on read_not-found_response_body

func ValidateReadNotImplementedResponseBody 

func ValidateReadNotImplementedResponseBody(body *ReadNotImplementedResponseBody) (err error)

ValidateReadNotImplementedResponseBody runs the validations defined on read_not-implemented_response_body

func ValidateRefTResponseBody 

func ValidateRefTResponseBody(body *RefTResponseBody) (err error)

ValidateRefTResponseBody runs the validations defined on RefTResponseBody

func ValidateSelfTResponseBody 

func ValidateSelfTResponseBody(body *SelfTResponseBody) (err error)

ValidateSelfTResponseBody runs the validations defined on SelfTResponseBody

func ValidateSelfWithDataTResponseBody 

func ValidateSelfWithDataTResponseBody(body *SelfWithDataTResponseBody) (err error)

ValidateSelfWithDataTResponseBody runs the validations defined on SelfWithDataTResponseBody

Types

type Client 

type Client struct {
	// List Doer is the HTTP client used to make requests to the list endpoint.
	ListDoer goahttp.Doer

	// Create Doer is the HTTP client used to make requests to the create endpoint.
	CreateDoer goahttp.Doer

	// Read Doer is the HTTP client used to make requests to the read endpoint.
	ReadDoer 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 order 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 order service servers.

func (*Client) BuildCreateRequest 

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

BuildCreateRequest instantiates a HTTP request object with method and path set to call the "order" service "create" endpoint

func (*Client) BuildListRequest 

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

BuildListRequest instantiates a HTTP request object with method and path set to call the "order" service "list" endpoint

func (*Client) BuildReadRequest 

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

BuildReadRequest instantiates a HTTP request object with method and path set to call the "order" service "read" endpoint

func (*Client) Create 

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

Create returns an endpoint that makes HTTP requests to the order service create server.

func (*Client) List 

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

List returns an endpoint that makes HTTP requests to the order service list server.

func (*Client) Read 

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

Read returns an endpoint that makes HTTP requests to the order service read server.

type CreateBadRequestResponseBody 

type CreateBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

CreateBadRequestResponseBody is the type of the "order" service "create" endpoint HTTP response body for the "bad-request" error.

type CreateInvalidParameterResponseBody 

type CreateInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

CreateInvalidParameterResponseBody is the type of the "order" service "create" endpoint HTTP response body for the "invalid-parameter" error.

type CreateInvalidScopesResponseBody 

type CreateInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

CreateInvalidScopesResponseBody is the type of the "order" service "create" endpoint HTTP response body for the "invalid-scopes" error.

type CreateNotFoundResponseBody 

type CreateNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

CreateNotFoundResponseBody is the type of the "order" service "create" endpoint HTTP response body for the "not-found" error.

type CreateNotImplementedResponseBody 

type CreateNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

CreateNotImplementedResponseBody is the type of the "order" service "create" endpoint HTTP response body for the "not-implemented" error.

type CreateRequestBody 

type CreateRequestBody struct {
	// Reference to service requested
	ServiceID string `form:"serviceID" json:"serviceID" xml:"serviceID"`
	// Reference to billable account
	AccountID string `form:"accountID" json:"accountID" xml:"accountID"`
	// Policy to control access to record an all generated artifacts
	PolicyID *string `form:"policyID,omitempty" json:"policyID,omitempty" xml:"policyID,omitempty"`
	// Optional customer provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Service parameters
	Parameters []*ParameterT `form:"parameters" json:"parameters" xml:"parameters"`
}

CreateRequestBody is the type of the "order" service "create" endpoint HTTP request body.

func NewCreateRequestBody 

func NewCreateRequestBody(p *order.CreatePayload) *CreateRequestBody

NewCreateRequestBody builds the HTTP request body from the payload of the "create" endpoint of the "order" service.

type CreateResponseBody 

type CreateResponseBody struct {
	// Order ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Order status
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// DateTime order was placed
	OrderedAt *string `form:"ordered_at,omitempty" json:"ordered_at,omitempty" xml:"ordered_at,omitempty"`
	// DateTime order processing started
	StartedAt *string `form:"started_at,omitempty" json:"started_at,omitempty" xml:"started_at,omitempty"`
	// DateTime order processing finished
	FinishedAt *string `form:"finished_at,omitempty" json:"finished_at,omitempty" xml:"finished_at,omitempty"`
	// Products delivered for this order
	Products []*ProductTResponseBody `form:"products,omitempty" json:"products,omitempty" xml:"products,omitempty"`
	// Reference to service requested
	Service *RefTResponseBody `form:"service,omitempty" json:"service,omitempty" xml:"service,omitempty"`
	// Reference to billable account
	Account *RefTResponseBody  `form:"account,omitempty" json:"account,omitempty" xml:"account,omitempty"`
	Links   *SelfTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
	// Optional customer provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Service parameters
	Parameters []*ParameterTResponseBody `form:"parameters,omitempty" json:"parameters,omitempty" xml:"parameters,omitempty"`
}

CreateResponseBody is the type of the "order" service "create" endpoint HTTP response body.

type DescribedByTResponseBody 

type DescribedByTResponseBody struct {
	Href *string `form:"href,omitempty" json:"href,omitempty" xml:"href,omitempty"`
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
}

DescribedByTResponseBody is used to define fields on response body types.

type ListBadRequestResponseBody 

type ListBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ListBadRequestResponseBody is the type of the "order" service "list" endpoint HTTP response body for the "bad-request" error.

type ListInvalidParameterResponseBody added in v0.25.0 

type ListInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

ListInvalidParameterResponseBody is the type of the "order" service "list" endpoint HTTP response body for the "invalid-parameter" error.

type ListInvalidScopesResponseBody 

type ListInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ListInvalidScopesResponseBody is the type of the "order" service "list" endpoint HTTP response body for the "invalid-scopes" error.

type ListNotImplementedResponseBody 

type ListNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ListNotImplementedResponseBody is the type of the "order" service "list" endpoint HTTP response body for the "not-implemented" error.

type ListResponseBody 

type ListResponseBody struct {
	// Orders
	Orders []*OrderListItemResponseBody `form:"orders,omitempty" json:"orders,omitempty" xml:"orders,omitempty"`
	// Time at which this list was valid
	AtTime *string `form:"at-time,omitempty" json:"at-time,omitempty" xml:"at-time,omitempty"`
	// Navigation links
	Links *NavTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

ListResponseBody is the type of the "order" service "list" endpoint HTTP response body. 

type NavTResponseBody struct {
	Self  *string `form:"self,omitempty" json:"self,omitempty" xml:"self,omitempty"`
	First *string `form:"first,omitempty" json:"first,omitempty" xml:"first,omitempty"`
	Next  *string `form:"next,omitempty" json:"next,omitempty" xml:"next,omitempty"`
}

NavTResponseBody is used to define fields on response body types.

type OrderListItemResponseBody 

type OrderListItemResponseBody struct {
	// Order ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Optional customer provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Order status
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// DateTime order was placed
	OrderedAt *string `form:"ordered_at,omitempty" json:"ordered_at,omitempty" xml:"ordered_at,omitempty"`
	// DateTime processing of order started
	StartedAt *string `form:"started_at,omitempty" json:"started_at,omitempty" xml:"started_at,omitempty"`
	// DateTime order was finished
	FinishedAt *string `form:"finished_at,omitempty" json:"finished_at,omitempty" xml:"finished_at,omitempty"`
	// ID of ordered service
	ServiceID *string `form:"service_id,omitempty" json:"service_id,omitempty" xml:"service_id,omitempty"`
	// ID of ordered service
	AccountID *string            `form:"account_id,omitempty" json:"account_id,omitempty" xml:"account_id,omitempty"`
	Links     *SelfTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

OrderListItemResponseBody is used to define fields on response body types.

type ParameterT 

type ParameterT struct {
	Name  *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

ParameterT is used to define fields on request body types.

type ParameterTResponseBody 

type ParameterTResponseBody struct {
	Name  *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

ParameterTResponseBody is used to define fields on response body types.

type ProductTResponseBody 

type ProductTResponseBody struct {
	ID       *string                    `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	Name     *string                    `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	Status   *string                    `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	MimeType *string                    `form:"mime-type,omitempty" json:"mime-type,omitempty" xml:"mime-type,omitempty"`
	Size     *int64                     `form:"size,omitempty" json:"size,omitempty" xml:"size,omitempty"`
	Links    *SelfWithDataTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

ProductTResponseBody is used to define fields on response body types.

type ReadBadRequestResponseBody 

type ReadBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ReadBadRequestResponseBody is the type of the "order" service "read" endpoint HTTP response body for the "bad-request" error.

type ReadInvalidScopesResponseBody 

type ReadInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ReadInvalidScopesResponseBody is the type of the "order" service "read" endpoint HTTP response body for the "invalid-scopes" error.

type ReadNotFoundResponseBody 

type ReadNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ReadNotFoundResponseBody is the type of the "order" service "read" endpoint HTTP response body for the "not-found" error.

type ReadNotImplementedResponseBody 

type ReadNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ReadNotImplementedResponseBody is the type of the "order" service "read" endpoint HTTP response body for the "not-implemented" error.

type ReadResponseBody 

type ReadResponseBody struct {
	// Order ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Order status
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// DateTime order was placed
	OrderedAt *string `form:"ordered_at,omitempty" json:"ordered_at,omitempty" xml:"ordered_at,omitempty"`
	// DateTime order processing started
	StartedAt *string `form:"started_at,omitempty" json:"started_at,omitempty" xml:"started_at,omitempty"`
	// DateTime order processing finished
	FinishedAt *string `form:"finished_at,omitempty" json:"finished_at,omitempty" xml:"finished_at,omitempty"`
	// Products delivered for this order
	Products []*ProductTResponseBody `form:"products,omitempty" json:"products,omitempty" xml:"products,omitempty"`
	// Reference to service requested
	Service *RefTResponseBody `form:"service,omitempty" json:"service,omitempty" xml:"service,omitempty"`
	// Reference to billable account
	Account *RefTResponseBody  `form:"account,omitempty" json:"account,omitempty" xml:"account,omitempty"`
	Links   *SelfTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
	// Optional customer provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Service parameters
	Parameters []*ParameterTResponseBody `form:"parameters,omitempty" json:"parameters,omitempty" xml:"parameters,omitempty"`
}

ReadResponseBody is the type of the "order" service "read" endpoint HTTP response body.

type RefTResponseBody 

type RefTResponseBody struct {
	ID    *string            `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	Links *SelfTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

RefTResponseBody is used to define fields on response body types.

type SelfTResponseBody 

type SelfTResponseBody struct {
	Self        *string                   `form:"self,omitempty" json:"self,omitempty" xml:"self,omitempty"`
	DescribedBy *DescribedByTResponseBody `form:"describedBy,omitempty" json:"describedBy,omitempty" xml:"describedBy,omitempty"`
}

SelfTResponseBody is used to define fields on response body types.

type SelfWithDataTResponseBody 

type SelfWithDataTResponseBody struct {
	Self        *string                   `form:"self,omitempty" json:"self,omitempty" xml:"self,omitempty"`
	DescribedBy *DescribedByTResponseBody `form:"describedBy,omitempty" json:"describedBy,omitempty" xml:"describedBy,omitempty"`
	Data        *string                   `form:"data,omitempty" json:"data,omitempty" xml:"data,omitempty"`
}

SelfWithDataTResponseBody is used to define fields on response body types.

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.