| Copyright | (c) 2016 Kyle Gwinnup |
|---|---|
| License | BSD-style |
| Maintainer | kpgwinnup@gmail.com |
| Stability | experimental |
| Portability | GHC |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.GoDaddy
Description
A library for interacting with GoDaddy's REST API
- data GoDaddyAuth = GoDaddyAuth String String
- getDomains :: GoDaddyAuth -> IO (Either GError [DomainSummary])
- updateDomainDetails :: GoDaddyAuth -> DomainUpdate -> IO (Either GError Bool)
- getDomain :: GoDaddyAuth -> String -> IO (Either GError DomainSummary)
- setDomainContacts :: GoDaddyAuth -> String -> Contacts -> IO (Either GError Bool)
- cancelDomainPrivacy :: GoDaddyAuth -> String -> IO (Either GError Bool)
- purchaseDomainPrivacy :: GoDaddyAuth -> String -> PrivacyPurchase -> IO (Either GError DomainPurchaseResponse)
- addDomainRecord :: GoDaddyAuth -> String -> DNSRecord -> IO (Either GError Bool)
- replaceAllDNSRecords :: GoDaddyAuth -> String -> [DNSRecord] -> IO (Either GError Bool)
- getDomainRecords :: GoDaddyAuth -> String -> Maybe String -> Maybe String -> IO (Either GError [DNSRecord])
- replaceAllDNSRecordsByType :: GoDaddyAuth -> String -> String -> IO (Either GError Bool)
- replaceAllDNSRecordsByTypeAndName :: GoDaddyAuth -> String -> String -> String -> IO (Either GError Bool)
- renewDomain :: GoDaddyAuth -> String -> IO (Either GError DomainPurchaseResponse)
- startDomainTransfer :: GoDaddyAuth -> String -> IO (Either GError DomainTransferIn)
- resendContactEmailVerification :: GoDaddyAuth -> String -> IO (Either GError Bool)
- getLegalAgreements :: GoDaddyAuth -> IO (Either GError [LegalAgreement])
- isDomainAvailable :: GoDaddyAuth -> String -> IO (Either GError DomainAvailableResponse)
- updateIdentityDocument :: GoDaddyAuth -> IdentityDocumentCreate -> IO (Either GError Bool)
- purchaseDomain :: GoDaddyAuth -> DomainPurchase -> IO (Either GError DomainPurchaseResponse)
- getSchemaForTld :: GoDaddyAuth -> String -> IO (Either GError Schema)
- validatePurchaseSchema :: GoDaddyAuth -> DomainPurchase -> IO (Either GError Bool)
- suggestDomain :: GoDaddyAuth -> String -> IO (Either GError [DomainSuggestion])
- getTldsForSale :: GoDaddyAuth -> IO (Either GError [TldSummary])
- getAbuseTicket :: GoDaddyAuth -> Integer -> IO (Either GError AbuseTicket)
- getAbuseTickets :: GoDaddyAuth -> IO (Either GError AbuseTicketList)
- createAbuseTicket :: GoDaddyAuth -> AbuseTicketCreate -> IO (Either GError AbuseTicketId)
- deleteAftermarketListing :: GoDaddyAuth -> String -> IO (Either GError AftermarketListingAction)
- addAftermarketExpiryListing :: GoDaddyAuth -> [AftermarketListingExpiryCreate] -> IO (Either GError AftermarketListingAction)
Documentation
data GoDaddyAuth Source #
GoDaddy Authentication structure, takes key and secret key
>>> let x = GoDaddyAuth <key> <secret>
Constructors
| GoDaddyAuth String String |
Instances
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
renewDomain :: GoDaddyAuth -> String -> IO (Either GError DomainPurchaseResponse) Source #
Renew the specified Domain
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
createAbuseTicket :: GoDaddyAuth -> AbuseTicketCreate -> IO (Either GError AbuseTicketId) Source #
Create a new abuse ticket
deleteAftermarketListing :: GoDaddyAuth -> String -> IO (Either GError AftermarketListingAction) Source #
Remove listings from GoDaddy Auction
addAftermarketExpiryListing :: GoDaddyAuth -> [AftermarketListingExpiryCreate] -> IO (Either GError AftermarketListingAction) Source #
Add expiry listings into GoDaddy Auction