godaddygo

README

godaddygo

Interact with the GoDaddy API via Golang

• Installation
• Details & Usage
  • Type-checking
• Examples
• Roadmap
  • Endpoints

---

🔥 Installation

go get -u github.com/oze4/godaddygo

📋 Details and Usage

• To import:

import (
  // ...
  "github.com/oze4/godaddygo"
)

• The main package, (github.com/oze4/godaddygo) provides everything you need to interact with the GoDaddy API.
• However, if you would like to type-check using types which are returned from godaddygo, you will need to use a specific package for "that" endpoint
• We mirrored endpoints found in the GoDaddy docs
• ⭐For user-land-type-checking, each endpoint has it's own package located at: github.com/oze4/godaddygo/pkg/<endpoint>

Type-checking

If you wanted to type-check using the data type for domain details, you would do:

// ...

import (
  // ...
  "github.com/oze4/godaddygo/pkg/domains"
)

// SomeFunc says 'leave me alone, vscode' 😉
func SomeFunc(dd domains.DomainDetails) { // <-- type-check using `DomainDetails`
  // ...
}

🚧 Roadmap

❗THIS LIBRARY SHOULD **NOT BE USED AT ALL** RIGHT NOW!❗as it is under heavy construction

Endpoints

Please see here for more information on GoDaddy API endpoints

🚫Not Available | 🚧In Progress | ✅Finished

Endpoint	Status
Abuse	🚫
Aftermarket	🚫
Agreements	🚫
Certificates	🚫
Countries	🚫
Domains	🚧
Orders	🚫
Shoppers	🚫
Subscriptions	🚫

Documentation

Index

• func NewDevelopmentAPI(o Options) api.Gateway
• func NewProductionAPI(o Options) api.Gateway
• type Options
  • func NewOptions(apikey, apisecret string) Options

Functions

func NewDevelopmentAPI

func NewDevelopmentAPI(o Options) api.Gateway

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

func NewProductionAPI

func NewProductionAPI(o Options) api.Gateway

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

Types

type Options

type Options interface {
	APIKey() string
	APISecret() string
}

Options hold the options for a new client

func NewOptions

func NewOptions(apikey, apisecret string) Options

NewOptions returns new options