api

Documentation

Index

• type Contacts
• type ContactsGetter
• type Domain
• type DomainGetter
• type Gateway
  • func InitDevelopment(r *http.Request) Gateway
  • func InitProduction(r *http.Request) Gateway
• type Privacy
• type PrivacyGetter
• type Records
• type RecordsGetter
• type V1
• type V1Getter

Types

type Contacts

type Contacts interface {
	Validate() *http.Request
}

Contacts builds the contacts piece of the URL

type ContactsGetter

type ContactsGetter interface {
	Contacts() Contacts
}

ContactsGetter allows for easy embedding (?)

type Domain

type Domain interface {
	ContactsGetter
	PrivacyGetter
	RecordsGetter
	Agreements([]string, bool, bool) *http.Request
	IsAvailable() (*domainsEndpoint.Available, error)
	GetDetails() (*domainsEndpoint.DomainDetails, error)
}

Domain represents the `domains` GoDaddy API endpoint

type DomainGetter

type DomainGetter interface {
	Domain(string) Domain
}

DomainGetter returns

type Gateway

type Gateway interface {
	V1Getter
}

Gateway allows you to select different versions of the GoDaddy API

func InitDevelopment

func InitDevelopment(r *http.Request) Gateway

InitDevelopment targets GoDaddy's development API (https://api.ote-godaddy.com)

func InitProduction

func InitProduction(r *http.Request) Gateway

InitProduction targets GoDaddy's production API (https://api.godaddy.com)

type Privacy

type Privacy interface {
	Purchase() *http.Request
	Delete() *http.Request
}

Privacy is a thing

type PrivacyGetter

type PrivacyGetter interface {
	Privacy() Privacy
}

PrivacyGetter makes embedding easier

type Records

type Records interface {
	GetAll() (*[]domainsEndpoint.DNSRecord, error)
	GetByType(string) (*[]domainsEndpoint.DNSRecord, error)
	GetByTypeName(string, string) (*[]domainsEndpoint.DNSRecord, error)
	SetValue(string, string, string) error
}

Records allows you to interact with DNS records for a specific domain. Get or set DNS records

type RecordsGetter

type RecordsGetter interface {
	Records() Records
}

RecordsGetter makes embedding easier

type V1

type V1 interface {
	DomainGetter
}

V1 holds all endpoints for version 1 of GoDaddy API

type V1Getter

type V1Getter interface {
	V1() V1
}

V1Getter makes embedding easier & more controllable