regions

package
v1.0.21 Latest Latest
Warning

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

Go to latest
Published: Sep 12, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ListRegion

type ListRegion struct {
	// How many regions to skip in the result.
	Offset uint `json:"offset,omitempty" url:"offset,omitempty"`

	// Limit the number of regions returned.
	Limit uint `json:"limit,omitempty" url:"limit,omitempty"`

	// Date comparison for when resulting regions were created.
	CreatedAt *common.DateComparison `json:"created_at,omitempty" url:"created_at,omitempty"`

	// Date comparison for when resulting regions were updated.
	UpdatedAt *common.DateComparison `json:"updated_at,omitempty" url:"updated_at,omitempty"`
}

func NewListRegion

func NewListRegion() *ListRegion

func (*ListRegion) List

func (r *ListRegion) List(config *medusa.Config) (*ListRegionResponse, error)

Retrieve a list of Regions.

func (*ListRegion) SetCreatedAt

func (r *ListRegion) SetCreatedAt(date *common.DateComparison) *ListRegion

func (*ListRegion) SetLimit

func (r *ListRegion) SetLimit(limit uint) *ListRegion

func (*ListRegion) SetOffset

func (r *ListRegion) SetOffset(offset uint) *ListRegion

func (*ListRegion) SetUpdatedAt

func (r *ListRegion) SetUpdatedAt(date *common.DateComparison) *ListRegion

type ListRegionData

type ListRegionData struct {
	// Array of regions
	Regions []*schema.Region `json:"regions"`
}

type ListRegionResponse

type ListRegionResponse struct {
	// Success response
	Data *ListRegionData

	// Error response
	Error *response.Error

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

type RetrieveRegionData

type RetrieveRegionData struct {
	Region []*schema.Region `json:"region"`
}

type RetrieveRegionResponse

type RetrieveRegionResponse struct {
	// Success response
	Data *RetrieveRegionData

	// Error response
	Error *response.Error

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

func Retrieve

func Retrieve(regionId string, config *medusa.Config) (*RetrieveRegionResponse, error)

Retrieves a Region.

Jump to

Keyboard shortcuts

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