location

Documentation

Overview

Package location implements API functions residing under /core/location.json. This path contains methods for querying existing locations.

Index

• type API
  • func NewAPI(c client.Client) API
• type Location

Types

type API

type API interface {
	List(ctx context.Context, page, limit int, search string) ([]Location, error)
	Get(ctx context.Context, identifier string) (Location, error)
	GetByCode(ctx context.Context, code string) (Location, error)
}

API contains methods for retrieving and listing locations.

func NewAPI

func NewAPI(c client.Client) API

NewAPI creates a new VLAN API instance with the given client.

type Location

type Location struct {
	Code        string `json:"code"`
	CityCode    string `json:"city_code"`
	Country     string `json:"country"`
	ID          string `json:"identifier"`
	Latitude    string `json:"lat"`
	Longitude   string `json:"lon"`
	Name        string `json:"name"`
	CountryName string `json:"country_name"`
}

Location is the metadata of a single location.