uri

README

/pkg/uri

• This package is "pseudo-code" for how our endpoints package will wind up looking
• It also helps us build out GoDaddy API URL's for our requests

Documentation

Index

• type Domain
• type Gateway
  • func Builder(isproduction bool) Gateway
• type Privacy
• type PrivacyGetter
• type Records
• type Version

Types

type Domain

type Domain interface {
	String() string
	Records() Records
	PrivacyGetter
}

Domain is the domains endpoint

type Gateway

type Gateway interface {
	// We do not validate the `Version(v string)`
	// parameter!
	// We expect you to have already validated the
	// version string beforehand
	Version(v string) Version
}

Gateway allows you to target specific API versions

func Builder

func Builder(isproduction bool) Gateway

Builder is the start of generating an API URL string

type Privacy

type Privacy interface {
	Purchase() string
	Remove() string
}

Privacy knows how to purchase/remove privacy for a domain

type PrivacyGetter

type PrivacyGetter interface {
	Privacy() Privacy
}

PrivacyGetter simplifies embedding

type Records

type Records interface {
	ByType(rectype string) string
	ByTypeName(rectype, recname string) string
	SetValue(rectype, recname string) string
	String() string
}

Records is the `/domain/<domain>/records` endpoint

type Version

type Version interface {
	Domain(domainName string) Domain
	DomainAvailability(domainName string, forTransfer bool) string
	GetMyDomains() string
	PurchaseDomain() string
}

Version are the API versions