orderedits

Documentation

Index

• type CompleteData
• type CompleteResponse
  • func Complete(id string, config *medusa.Config) (*CompleteResponse, error)
• type DeclineData
• type DeclineOrderEdit
  • func NewDeclineOrderEdit() *DeclineOrderEdit
  • func (d *DeclineOrderEdit) Decline(id string, config *medusa.Config) (*DeclineResponse, error)
  • func (d *DeclineOrderEdit) SetDeclineReason(reason string) *DeclineOrderEdit
• type DeclineResponse
• type RetrieveData
• type RetrieveResponse
  • func Retrieve(id string, config *medusa.Config) (*RetrieveResponse, error)

Types

type CompleteData

type CompleteData struct {
	// Gift Cards are redeemable and represent a value that can be used towards the payment of an Order.
	OrderEdit *schema.OrderEdit `json:"order_edit"`
}

type CompleteResponse

type CompleteResponse struct {
	// Success response
	Data *CompleteData

	// Error response
	Error *response.Error

	// Errors in case of multiple errors
	Errors *response.Errors
}

func Complete

func Complete(id string, config *medusa.Config) (*CompleteResponse, error)

type DeclineData

type DeclineData struct {
	OrderEdit *schema.OrderEdit `json:"order_edit"`
}

type DeclineOrderEdit

type DeclineOrderEdit struct {
	DeclinedReason string `json:"declined_reason,omitempty"`
}

func NewDeclineOrderEdit

func NewDeclineOrderEdit() *DeclineOrderEdit

func (*DeclineOrderEdit) Decline

func (d *DeclineOrderEdit) Decline(id string, config *medusa.Config) (*DeclineResponse, error)

func (*DeclineOrderEdit) SetDeclineReason

func (d *DeclineOrderEdit) SetDeclineReason(reason string) *DeclineOrderEdit

type DeclineResponse

type DeclineResponse struct {
	// Success response
	Data *DeclineData

	// Error response
	Error *response.Error

	// Errors in case of multiple errors
	Errors *response.Errors
}

type RetrieveData

type RetrieveData struct {
	// Gift Cards are redeemable and represent a value that can be used towards the payment of an Order.
	OrderEdit *schema.OrderEdit `json:"order_edit"`
}

type RetrieveResponse

type RetrieveResponse struct {
	// Success response
	Data *RetrieveData

	// Error response
	Error *response.Error

	// Errors in case of multiple errors
	Errors *response.Errors
}

func Retrieve

func Retrieve(id string, config *medusa.Config) (*RetrieveResponse, error)

Retrieves a OrderEdit.