Skip to content

Golang client for the Godaddy Domain API generated using Swagger Codegen

Notifications You must be signed in to change notification settings

kryptoslogic/godaddy-domainclient

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Go API client for godaddy

Looking for the old version?

Use tag v0.1.0, otherwise use v1.0.0 upwards.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version:
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Usage

import godaddy "github.com/kryptoslogic/godaddy-domainclient"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.ote-godaddy.com

Class Method HTTP request Description
V1Api Available Get /v1/domains/available Determine whether or not the specified domain is available for purchase
V1Api AvailableBulk Post /v1/domains/available Determine whether or not the specified domains are available for purchase
V1Api Cancel Delete /v1/domains/{domain} Cancel a purchased domain
V1Api CancelPrivacy Delete /v1/domains/{domain}/privacy Submit a privacy cancellation request for the given domain
V1Api ContactsValidate Post /v1/domains/contacts/validate Validate the request body using the Domain Contact Validation Schema for specified domains.
V1Api Get Get /v1/domains/{domain} Retrieve details for the specified Domain
V1Api GetAgreement Get /v1/domains/agreements Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons
V1Api List Get /v1/domains Retrieve a list of Domains for the specified Shopper
V1Api Purchase Post /v1/domains/purchase Purchase and register the specified Domain
V1Api PurchasePrivacy Post /v1/domains/{domain}/privacy/purchase Purchase privacy for a specified domain
V1Api RecordAdd Patch /v1/domains/{domain}/records Add the specified DNS Records to the specified Domain
V1Api RecordGet Get /v1/domains/{domain}/records/{type}/{name} Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name
V1Api RecordReplace Put /v1/domains/{domain}/records Replace all DNS Records for the specified Domain
V1Api RecordReplaceType Put /v1/domains/{domain}/records/{type} Replace all DNS Records for the specified Domain with the specified Type
V1Api RecordReplaceTypeName Put /v1/domains/{domain}/records/{type}/{name} Replace all DNS Records for the specified Domain with the specified Type and Name
V1Api Renew Post /v1/domains/{domain}/renew Renew the specified Domain
V1Api Schema Get /v1/domains/purchase/schema/{tld} Retrieve the schema to be submitted when registering a Domain for the specified TLD
V1Api Suggest Get /v1/domains/suggest Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history
V1Api Tlds Get /v1/domains/tlds Retrieves a list of TLDs supported and enabled for sale
V1Api TransferIn Post /v1/domains/{domain}/transfer Purchase and start or restart transfer process
V1Api Update Patch /v1/domains/{domain} Update details for the specified Domain
V1Api UpdateContacts Patch /v1/domains/{domain}/contacts Update domain
V1Api Validate Post /v1/domains/purchase/validate Validate the request body using the Domain Purchase Schema for the specified TLD
V1Api VerifyEmail Post /v1/domains/{domain}/verifyRegistrantEmail Re-send Contact E-mail Verification for specified Domain
V2Api DomainsForwardsDelete Delete /v2/customers/{customerId}/domains/forwards/{fqdn} Submit a forwarding cancellation request for the given fqdn
V2Api DomainsForwardsGet Get /v2/customers/{customerId}/domains/forwards/{fqdn} Retrieve the forwarding information for the given fqdn
V2Api DomainsForwardsPut Put /v2/customers/{customerId}/domains/forwards/{fqdn} Modify the forwarding information for the given fqdn

Documentation For Models

Documentation For Authorization

You must authenticate to endpoints using your API key and secret.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

Kryptos Logic

About

Golang client for the Godaddy Domain API generated using Swagger Codegen

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages