godaddy-0.1.0.3: Haskell bindings for the GoDaddy API

Copyright(c) 2016 Kyle Gwinnup
LicenseBSD-style
Maintainerkpgwinnup@gmail.com
Stabilityexperimental
PortabilityGHC
Safe HaskellNone
LanguageHaskell2010

Network.GoDaddy

Description

A library for interacting with GoDaddy's REST API

Synopsis

Documentation

data GoDaddyAuth Source #

GoDaddy Authentication structure, takes key and secret key

>>> let x = GoDaddyAuth <key> <secret>

Constructors

GoDaddyAuth String String 

getDomains :: GoDaddyAuth -> IO (Either GError [DomainSummary]) Source #

Retrieve a list of Domains for the specified Shopper

updateDomainDetails :: GoDaddyAuth -> DomainUpdate -> IO (Either GError Bool) Source #

Update details for the specified Domain

getDomain :: GoDaddyAuth -> String -> IO (Either GError DomainSummary) Source #

Retrieve details for the specified Domain

>>> getDomain auth "example.io"

setDomainContacts :: GoDaddyAuth -> String -> Contacts -> IO (Either GError Bool) Source #

Update domain contacts

>>> setDomainContacts auth "example.com" contacts

cancelDomainPrivacy :: GoDaddyAuth -> String -> IO (Either GError Bool) Source #

Submit a privacy cancellation request for the given domain

>>> cancelDomainPrivacy auth "example.com"

purchaseDomainPrivacy :: GoDaddyAuth -> String -> PrivacyPurchase -> IO (Either GError DomainPurchaseResponse) Source #

Purchase privacy for a specified domain

>>> purchaseDomainPrivacy auth "example.com" privacyPuchase

addDomainRecord :: GoDaddyAuth -> String -> DNSRecord -> IO (Either GError Bool) Source #

Add the specified DNS Records to the specified Domain

replaceAllDNSRecords :: GoDaddyAuth -> String -> [DNSRecord] -> IO (Either GError Bool) Source #

Replace all DNS Records for the specified Domain

getDomainRecords :: GoDaddyAuth -> String -> Maybe String -> Maybe String -> IO (Either GError [DNSRecord]) Source #

Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name

replaceAllDNSRecordsByType :: GoDaddyAuth -> String -> String -> IO (Either GError Bool) Source #

Replace all DNS Records for the specified Domain with the specified Type

replaceAllDNSRecordsByTypeAndName :: GoDaddyAuth -> String -> String -> String -> IO (Either GError Bool) Source #

Replace all DNS Records for the specified Domain with the specified Type and Name

startDomainTransfer :: GoDaddyAuth -> String -> IO (Either GError DomainTransferIn) Source #

Purchase and start or restart transfer process

resendContactEmailVerification :: GoDaddyAuth -> String -> IO (Either GError Bool) Source #

Re-send Contact E-mail Verification for specified Domain

getLegalAgreements :: GoDaddyAuth -> IO (Either GError [LegalAgreement]) Source #

Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons

isDomainAvailable :: GoDaddyAuth -> String -> IO (Either GError DomainAvailableResponse) Source #

Determine whether or not the specified domain is available for purchase

updateIdentityDocument :: GoDaddyAuth -> IdentityDocumentCreate -> IO (Either GError Bool) Source #

Upload an identity document for Real Name Validation

purchaseDomain :: GoDaddyAuth -> DomainPurchase -> IO (Either GError DomainPurchaseResponse) Source #

Purchase and register the specified Domain

getSchemaForTld :: GoDaddyAuth -> String -> IO (Either GError Schema) Source #

Retrieve the schema to be submitted when registering a Domain for the specified TLD

validatePurchaseSchema :: GoDaddyAuth -> DomainPurchase -> IO (Either GError Bool) Source #

Validate the request body using the Domain Purchase Schema for the specified TLD

suggestDomain :: GoDaddyAuth -> String -> IO (Either GError [DomainSuggestion]) Source #

Suggest alternate Domain names based on a seed Domain or set of keywords

getTldsForSale :: GoDaddyAuth -> IO (Either GError [TldSummary]) Source #

Retrieves a list of TLDs supported and enabled for sale

getAbuseTicket :: GoDaddyAuth -> Integer -> IO (Either GError AbuseTicket) Source #

Return the abuse ticket data for a given ticket id

getAbuseTickets :: GoDaddyAuth -> IO (Either GError AbuseTicketList) Source #

List all abuse tickets ids that match user provided filters