namedotcom

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 27, 2026 License: BSD-2-Clause Imports: 11 Imported by: 0

README

name-dot-com-core-client

Go client for the name.com Core API, generated from the upstream OpenAPI spec via oapi-codegen.

The generated client and the pinned spec are committed, so consumers can go get this module without needing codegen tooling installed.

Install

go get github.com/tadhunt/name-dot-com-core-client

Authentication

The name.com API uses HTTP Basic auth with your username and an API token from the API Token Management page in your name.com account. The generator does not hardcode auth — inject the header yourself via WithRequestEditorFn.

Base URLs

  • Production: https://api.name.com
  • Sandbox (preloaded with test credit): https://api.dev.name.com

Example: create an SRV record

package main

import (
	"context"
	"encoding/base64"
	"fmt"
	"log"
	"net/http"

	namedotcom "github.com/tadhunt/name-dot-com-core-client"
)

func ptr[T any](v T) *T { return &v }

func main() {
	const baseURL = "https://api.name.com"

	user := "your-namecom-username"
	token := "your-api-token"
	auth := "Basic " + base64.StdEncoding.EncodeToString([]byte(user+":"+token))

	client, err := namedotcom.NewClientWithResponses(
		baseURL,
		namedotcom.WithRequestEditorFn(func(ctx context.Context, req *http.Request) error {
			req.Header.Set("Authorization", auth)
			req.Header.Set("Content-Type", "application/json")
			return nil
		}),
	)
	if err != nil {
		log.Fatal(err)
	}

	// Create:
	//   _service._proto.subdomain.example.com  SRV  <prio> <weight> <port> target.example.com.
	//
	// Per the spec, Host is "_{service}._{protocol}.{subdomain}" relative to
	// the zone, and Answer for SRV is "{weight} {port} {target}" — Priority
	// is a separate field on the request body.
	resp, err := client.CreateRecordWithResponse(
		context.Background(),
		"example.com",
		namedotcom.CreateRecordJSONRequestBody{
			Host:     ptr("_service._tcp.subdomain"),
			Type:     ptr("SRV"),
			Answer:   ptr("5 5060 target.example.com."),
			Priority: ptr(int64(0)),
			Ttl:      300,
		},
	)
	if err != nil {
		log.Fatal(err)
	}
	if resp.StatusCode() != http.StatusOK {
		log.Fatalf("unexpected status: %s\nbody: %s", resp.Status(), string(resp.Body))
	}

	if resp.JSON200 != nil && resp.JSON200.Id != nil {
		fmt.Printf("created record id=%d\n", *resp.JSON200.Id)
	}
}

Client surface

Two constructors are generated:

  • NewClient(server string, opts ...ClientOption) (*Client, error) — methods return raw *http.Response.
  • NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error) — methods return typed wrappers with .JSON200, .JSON400, .Body, .StatusCode(), etc. Prefer this one in most cases.

Available ClientOptions:

  • WithHTTPClient(doer HttpRequestDoer) — supply a custom *http.Client (for timeouts, retries, instrumentation).
  • WithBaseURL(baseURL string) — override the server URL after construction.
  • WithRequestEditorFn(fn RequestEditorFn) — mutate every outgoing request; the canonical place to inject auth headers.

DNS record methods (typed-response variants):

  • ListRecordsWithResponse(ctx, domain, params)
  • CreateRecordWithResponse(ctx, domain, body)
  • GetRecordWithResponse(ctx, domain, id)
  • UpdateRecordWithResponse(ctx, domain, id, body) — full overwrite, all required fields must be supplied
  • DeleteRecordWithResponse(ctx, domain, id)

Most fields on Record are pointer types because they are optional in the spec. The ptr generic helper above is a convenient way to take addresses of literal values.

Per-operation response wrappers are suffixed Resp (e.g. CreateRecordResp) to avoid name collisions with spec-defined schemas such as CheckAccountBalanceResponse.

Regenerating from the upstream spec

The upstream spec is OpenAPI 3.1 and contains a few semantic bugs that oapi-codegen rejects. The Makefile handles this end-to-end: it fetches the spec, down-converts it to 3.0, applies a small awk patch (see scripts/fix-spec.awk), runs go generate, and builds.

make update-spec all   # fetch + patch + generate + build
make all               # generate + build from the committed spec

make update-spec requires curl, npx (Node), and awk. make all only requires the Go toolchain and oapi-codegen / staticcheck on $PATH.

License

See LICENSE.

Documentation

Overview

Package namedotcom provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.0 DO NOT EDIT.

Index

Constants

View Source
const (
	BasicAuthScopes = "BasicAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewCancelTransferRequest

func NewCancelTransferRequest(server string, domainName string) (*http.Request, error)

NewCancelTransferRequest generates requests for CancelTransfer

func NewCheckAccountBalanceRequest

func NewCheckAccountBalanceRequest(server string) (*http.Request, error)

NewCheckAccountBalanceRequest generates requests for CheckAccountBalance

func NewCheckAvailabilityRequest

func NewCheckAvailabilityRequest(server string, body CheckAvailabilityJSONRequestBody) (*http.Request, error)

NewCheckAvailabilityRequest calls the generic CheckAvailability builder with application/json body

func NewCheckAvailabilityRequestWithBody

func NewCheckAvailabilityRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCheckAvailabilityRequestWithBody generates requests for CheckAvailability with any type of body

func NewCreateAccountRequest

func NewCreateAccountRequest(server string, body CreateAccountJSONRequestBody) (*http.Request, error)

NewCreateAccountRequest calls the generic CreateAccount builder with application/json body

func NewCreateAccountRequestWithBody

func NewCreateAccountRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateAccountRequestWithBody generates requests for CreateAccount with any type of body

func NewCreateDNSSECRequest

func NewCreateDNSSECRequest(server string, domainName string, body CreateDNSSECJSONRequestBody) (*http.Request, error)

NewCreateDNSSECRequest calls the generic CreateDNSSEC builder with application/json body

func NewCreateDNSSECRequestWithBody

func NewCreateDNSSECRequestWithBody(server string, domainName string, contentType string, body io.Reader) (*http.Request, error)

NewCreateDNSSECRequestWithBody generates requests for CreateDNSSEC with any type of body

func NewCreateDomainRequest

func NewCreateDomainRequest(server string, params *CreateDomainParams, body CreateDomainJSONRequestBody) (*http.Request, error)

NewCreateDomainRequest calls the generic CreateDomain builder with application/json body

func NewCreateDomainRequestWithBody

func NewCreateDomainRequestWithBody(server string, params *CreateDomainParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateDomainRequestWithBody generates requests for CreateDomain with any type of body

func NewCreateEmailForwardingRequest

func NewCreateEmailForwardingRequest(server string, domainName string, body CreateEmailForwardingJSONRequestBody) (*http.Request, error)

NewCreateEmailForwardingRequest calls the generic CreateEmailForwarding builder with application/json body

func NewCreateEmailForwardingRequestWithBody

func NewCreateEmailForwardingRequestWithBody(server string, domainName string, contentType string, body io.Reader) (*http.Request, error)

NewCreateEmailForwardingRequestWithBody generates requests for CreateEmailForwarding with any type of body

func NewCreateRecordRequest

func NewCreateRecordRequest(server string, domainName string, body CreateRecordJSONRequestBody) (*http.Request, error)

NewCreateRecordRequest calls the generic CreateRecord builder with application/json body

func NewCreateRecordRequestWithBody

func NewCreateRecordRequestWithBody(server string, domainName string, contentType string, body io.Reader) (*http.Request, error)

NewCreateRecordRequestWithBody generates requests for CreateRecord with any type of body

func NewCreateTransferRequest

func NewCreateTransferRequest(server string, body CreateTransferJSONRequestBody) (*http.Request, error)

NewCreateTransferRequest calls the generic CreateTransfer builder with application/json body

func NewCreateTransferRequestWithBody

func NewCreateTransferRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateTransferRequestWithBody generates requests for CreateTransfer with any type of body

func NewCreateURLForwardingRequest

func NewCreateURLForwardingRequest(server string, domainName string, body CreateURLForwardingJSONRequestBody) (*http.Request, error)

NewCreateURLForwardingRequest calls the generic CreateURLForwarding builder with application/json body

func NewCreateURLForwardingRequestWithBody

func NewCreateURLForwardingRequestWithBody(server string, domainName string, contentType string, body io.Reader) (*http.Request, error)

NewCreateURLForwardingRequestWithBody generates requests for CreateURLForwarding with any type of body

func NewCreateVanityNameserverRequest

func NewCreateVanityNameserverRequest(server string, domainName string, body CreateVanityNameserverJSONRequestBody) (*http.Request, error)

NewCreateVanityNameserverRequest calls the generic CreateVanityNameserver builder with application/json body

func NewCreateVanityNameserverRequestWithBody

func NewCreateVanityNameserverRequestWithBody(server string, domainName string, contentType string, body io.Reader) (*http.Request, error)

NewCreateVanityNameserverRequestWithBody generates requests for CreateVanityNameserver with any type of body

func NewDeleteDNSSECRequest

func NewDeleteDNSSECRequest(server string, domainName string, digest string) (*http.Request, error)

NewDeleteDNSSECRequest generates requests for DeleteDNSSEC

func NewDeleteEmailForwardingRequest

func NewDeleteEmailForwardingRequest(server string, domainName string, emailBox string) (*http.Request, error)

NewDeleteEmailForwardingRequest generates requests for DeleteEmailForwarding

func NewDeleteRecordRequest

func NewDeleteRecordRequest(server string, domainName string, id int32) (*http.Request, error)

NewDeleteRecordRequest generates requests for DeleteRecord

func NewDeleteSubscriptionRequest

func NewDeleteSubscriptionRequest(server string, id int32) (*http.Request, error)

NewDeleteSubscriptionRequest generates requests for DeleteSubscription

func NewDeleteURLForwardingRequest

func NewDeleteURLForwardingRequest(server string, domainName string, host string) (*http.Request, error)

NewDeleteURLForwardingRequest generates requests for DeleteURLForwarding

func NewDeleteVanityNameserverRequest

func NewDeleteVanityNameserverRequest(server string, domainName string, hostname string) (*http.Request, error)

NewDeleteVanityNameserverRequest generates requests for DeleteVanityNameserver

func NewDisableAutorenewRequest

func NewDisableAutorenewRequest(server string, domainName string, params *DisableAutorenewParams) (*http.Request, error)

NewDisableAutorenewRequest generates requests for DisableAutorenew

func NewDisableWhoisPrivacyRequest

func NewDisableWhoisPrivacyRequest(server string, domainName string, params *DisableWhoisPrivacyParams) (*http.Request, error)

NewDisableWhoisPrivacyRequest generates requests for DisableWhoisPrivacy

func NewEnableAutorenewRequest

func NewEnableAutorenewRequest(server string, domainName string, params *EnableAutorenewParams) (*http.Request, error)

NewEnableAutorenewRequest generates requests for EnableAutorenew

func NewEnableWhoisPrivacyRequest

func NewEnableWhoisPrivacyRequest(server string, domainName string, params *EnableWhoisPrivacyParams) (*http.Request, error)

NewEnableWhoisPrivacyRequest generates requests for EnableWhoisPrivacy

func NewGetAuthCodeForDomainRequest

func NewGetAuthCodeForDomainRequest(server string, domainName string) (*http.Request, error)

NewGetAuthCodeForDomainRequest generates requests for GetAuthCodeForDomain

func NewGetDNSSECRequest

func NewGetDNSSECRequest(server string, domainName string, digest string) (*http.Request, error)

NewGetDNSSECRequest generates requests for GetDNSSEC

func NewGetDomainRequest

func NewGetDomainRequest(server string, domainName string) (*http.Request, error)

NewGetDomainRequest generates requests for GetDomain

func NewGetEmailForwardingRequest

func NewGetEmailForwardingRequest(server string, domainName string, emailBox string) (*http.Request, error)

NewGetEmailForwardingRequest generates requests for GetEmailForwarding

func NewGetOrderRequest

func NewGetOrderRequest(server string, orderId int32) (*http.Request, error)

NewGetOrderRequest generates requests for GetOrder

func NewGetPricingForDomainRequest

func NewGetPricingForDomainRequest(server string, domainName string, params *GetPricingForDomainParams) (*http.Request, error)

NewGetPricingForDomainRequest generates requests for GetPricingForDomain

func NewGetRecordRequest

func NewGetRecordRequest(server string, domainName string, id int32) (*http.Request, error)

NewGetRecordRequest generates requests for GetRecord

func NewGetRequirementRequest

func NewGetRequirementRequest(server string, tld string) (*http.Request, error)

NewGetRequirementRequest generates requests for GetRequirement

func NewGetSubscribedNotificationsRequest

func NewGetSubscribedNotificationsRequest(server string) (*http.Request, error)

NewGetSubscribedNotificationsRequest generates requests for GetSubscribedNotifications

func NewGetTransferRequest

func NewGetTransferRequest(server string, domainName string) (*http.Request, error)

NewGetTransferRequest generates requests for GetTransfer

func NewGetURLForwardingRequest

func NewGetURLForwardingRequest(server string, domainName string, host string) (*http.Request, error)

NewGetURLForwardingRequest generates requests for GetURLForwarding

func NewGetVanityNameserverRequest

func NewGetVanityNameserverRequest(server string, domainName string, hostname string) (*http.Request, error)

NewGetVanityNameserverRequest generates requests for GetVanityNameserver

func NewHelloRequest

func NewHelloRequest(server string) (*http.Request, error)

NewHelloRequest generates requests for Hello

func NewListDNSSECsRequest

func NewListDNSSECsRequest(server string, domainName string) (*http.Request, error)

NewListDNSSECsRequest generates requests for ListDNSSECs

func NewListDomainsRequest

func NewListDomainsRequest(server string, params *ListDomainsParams) (*http.Request, error)

NewListDomainsRequest generates requests for ListDomains

func NewListEmailForwardingsRequest

func NewListEmailForwardingsRequest(server string, domainName string, params *ListEmailForwardingsParams) (*http.Request, error)

NewListEmailForwardingsRequest generates requests for ListEmailForwardings

func NewListOrdersRequest

func NewListOrdersRequest(server string, params *ListOrdersParams) (*http.Request, error)

NewListOrdersRequest generates requests for ListOrders

func NewListRecordsRequest

func NewListRecordsRequest(server string, domainName string, params *ListRecordsParams) (*http.Request, error)

NewListRecordsRequest generates requests for ListRecords

func NewListTransfersRequest

func NewListTransfersRequest(server string, params *ListTransfersParams) (*http.Request, error)

NewListTransfersRequest generates requests for ListTransfers

func NewListURLForwardingsRequest

func NewListURLForwardingsRequest(server string, domainName string, params *ListURLForwardingsParams) (*http.Request, error)

NewListURLForwardingsRequest generates requests for ListURLForwardings

func NewListVanityNameserversRequest

func NewListVanityNameserversRequest(server string, domainName string, params *ListVanityNameserversParams) (*http.Request, error)

NewListVanityNameserversRequest generates requests for ListVanityNameservers

func NewLockDomainRequest

func NewLockDomainRequest(server string, domainName string, params *LockDomainParams) (*http.Request, error)

NewLockDomainRequest generates requests for LockDomain

func NewModifySubscriptionRequest

func NewModifySubscriptionRequest(server string, id int32, body ModifySubscriptionJSONRequestBody) (*http.Request, error)

NewModifySubscriptionRequest calls the generic ModifySubscription builder with application/json body

func NewModifySubscriptionRequestWithBody

func NewModifySubscriptionRequestWithBody(server string, id int32, contentType string, body io.Reader) (*http.Request, error)

NewModifySubscriptionRequestWithBody generates requests for ModifySubscription with any type of body

func NewPremiumDomainListsRequest

func NewPremiumDomainListsRequest(server string) (*http.Request, error)

NewPremiumDomainListsRequest generates requests for PremiumDomainLists

func NewPurchasePrivacyRequest

func NewPurchasePrivacyRequest(server string, domainName string, params *PurchasePrivacyParams, body PurchasePrivacyJSONRequestBody) (*http.Request, error)

NewPurchasePrivacyRequest calls the generic PurchasePrivacy builder with application/json body

func NewPurchasePrivacyRequestWithBody

func NewPurchasePrivacyRequestWithBody(server string, domainName string, params *PurchasePrivacyParams, contentType string, body io.Reader) (*http.Request, error)

NewPurchasePrivacyRequestWithBody generates requests for PurchasePrivacy with any type of body

func NewRenewDomainRequest

func NewRenewDomainRequest(server string, domainName string, body RenewDomainJSONRequestBody) (*http.Request, error)

NewRenewDomainRequest calls the generic RenewDomain builder with application/json body

func NewRenewDomainRequestWithBody

func NewRenewDomainRequestWithBody(server string, domainName string, contentType string, body io.Reader) (*http.Request, error)

NewRenewDomainRequestWithBody generates requests for RenewDomain with any type of body

func NewSearchRequest

func NewSearchRequest(server string, body SearchJSONRequestBody) (*http.Request, error)

NewSearchRequest calls the generic Search builder with application/json body

func NewSearchRequestWithBody

func NewSearchRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSearchRequestWithBody generates requests for Search with any type of body

func NewSetContactsRequest

func NewSetContactsRequest(server string, domainName string, body SetContactsJSONRequestBody) (*http.Request, error)

NewSetContactsRequest calls the generic SetContacts builder with application/json body

func NewSetContactsRequestWithBody

func NewSetContactsRequestWithBody(server string, domainName string, contentType string, body io.Reader) (*http.Request, error)

NewSetContactsRequestWithBody generates requests for SetContacts with any type of body

func NewSetNameserversRequest

func NewSetNameserversRequest(server string, domainName string, body SetNameserversJSONRequestBody) (*http.Request, error)

NewSetNameserversRequest calls the generic SetNameservers builder with application/json body

func NewSetNameserversRequestWithBody

func NewSetNameserversRequestWithBody(server string, domainName string, contentType string, body io.Reader) (*http.Request, error)

NewSetNameserversRequestWithBody generates requests for SetNameservers with any type of body

func NewSubscribeToNotificationRequest

func NewSubscribeToNotificationRequest(server string, body SubscribeToNotificationJSONRequestBody) (*http.Request, error)

NewSubscribeToNotificationRequest calls the generic SubscribeToNotification builder with application/json body

func NewSubscribeToNotificationRequestWithBody

func NewSubscribeToNotificationRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSubscribeToNotificationRequestWithBody generates requests for SubscribeToNotification with any type of body

func NewTldPriceListRequest

func NewTldPriceListRequest(server string, params *TldPriceListParams) (*http.Request, error)

NewTldPriceListRequest generates requests for TldPriceList

func NewUnlockDomainRequest

func NewUnlockDomainRequest(server string, domainName string, params *UnlockDomainParams) (*http.Request, error)

NewUnlockDomainRequest generates requests for UnlockDomain

func NewUnverifiedContactsListRequest

func NewUnverifiedContactsListRequest(server string, params *UnverifiedContactsListParams) (*http.Request, error)

NewUnverifiedContactsListRequest generates requests for UnverifiedContactsList

func NewUpdateDomainRequest

func NewUpdateDomainRequest(server string, domainName string, body UpdateDomainJSONRequestBody) (*http.Request, error)

NewUpdateDomainRequest calls the generic UpdateDomain builder with application/json body

func NewUpdateDomainRequestWithBody

func NewUpdateDomainRequestWithBody(server string, domainName string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateDomainRequestWithBody generates requests for UpdateDomain with any type of body

func NewUpdateEmailForwardingRequest

func NewUpdateEmailForwardingRequest(server string, domainName string, emailBox string, body UpdateEmailForwardingJSONRequestBody) (*http.Request, error)

NewUpdateEmailForwardingRequest calls the generic UpdateEmailForwarding builder with application/json body

func NewUpdateEmailForwardingRequestWithBody

func NewUpdateEmailForwardingRequestWithBody(server string, domainName string, emailBox string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateEmailForwardingRequestWithBody generates requests for UpdateEmailForwarding with any type of body

func NewUpdateRecordRequest

func NewUpdateRecordRequest(server string, domainName string, id int32, body UpdateRecordJSONRequestBody) (*http.Request, error)

NewUpdateRecordRequest calls the generic UpdateRecord builder with application/json body

func NewUpdateRecordRequestWithBody

func NewUpdateRecordRequestWithBody(server string, domainName string, id int32, contentType string, body io.Reader) (*http.Request, error)

NewUpdateRecordRequestWithBody generates requests for UpdateRecord with any type of body

func NewUpdateURLForwardingRequest

func NewUpdateURLForwardingRequest(server string, domainName string, host string, body UpdateURLForwardingJSONRequestBody) (*http.Request, error)

NewUpdateURLForwardingRequest calls the generic UpdateURLForwarding builder with application/json body

func NewUpdateURLForwardingRequestWithBody

func NewUpdateURLForwardingRequestWithBody(server string, domainName string, host string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateURLForwardingRequestWithBody generates requests for UpdateURLForwarding with any type of body

func NewUpdateVanityNameserverRequest

func NewUpdateVanityNameserverRequest(server string, domainName string, hostname string, body UpdateVanityNameserverJSONRequestBody) (*http.Request, error)

NewUpdateVanityNameserverRequest calls the generic UpdateVanityNameserver builder with application/json body

func NewUpdateVanityNameserverRequestWithBody

func NewUpdateVanityNameserverRequestWithBody(server string, domainName string, hostname string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateVanityNameserverRequestWithBody generates requests for UpdateVanityNameserver with any type of body

func NewVerifyContactRequest

func NewVerifyContactRequest(server string, verificationId int32, params *VerifyContactParams) (*http.Request, error)

NewVerifyContactRequest generates requests for VerifyContact

func NewZoneCheckRequest

func NewZoneCheckRequest(server string, body ZoneCheckJSONRequestBody) (*http.Request, error)

NewZoneCheckRequest calls the generic ZoneCheck builder with application/json body

func NewZoneCheckRequestWithBody

func NewZoneCheckRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewZoneCheckRequestWithBody generates requests for ZoneCheck with any type of body

Types

type Account

type Account struct {
	// AccountId AccountId is the unique id of account.
	AccountId *int32 `json:"accountId,omitempty"`

	// AccountName AccountName is the unique name of the account.  Minimum length is 6 characters, maximum length is 60.
	AccountName *string `json:"accountName,omitempty"`

	// AutoRenew When set to true, domains in this account will be automatically renewed before expiration.
	AutoRenew *bool `json:"autoRenew,omitempty"`

	// Contacts Contacts stores the contact information for the roles related to domains.
	Contacts *Contacts `json:"contacts,omitempty"`

	// CreateDate CreateDate is the date the account was created.
	CreateDate *time.Time `json:"createDate,omitempty"`

	// Password Password has minimum length of 7 characters. It must contain at least 1 letter and at least 1 number/symbol.
	Password *string `json:"password,omitempty"`
}

Account Account lists all the data for an account.

type AccountCreditBalanceChange

type AccountCreditBalanceChange struct {
	// AccountId The account ID the subscription is for
	AccountId *int64 `json:"accountId,omitempty"`

	// Balance The remaining balance of account credit
	Balance *float64 `json:"balance,omitempty"`

	// EventName The name of the subscription event
	EventName *string `json:"eventName,omitempty"`
}

AccountCreditBalanceChange defines model for AccountCreditBalanceChange.

type AuthCodeResponse

type AuthCodeResponse struct {
	// AuthCode AuthCode is the authorization code needed to transfer a domain to another registrar. If you are storing auth codes, be sure to store them in a secure manner.
	AuthCode string `json:"authCode"`
}

AuthCodeResponse AuthCodeResponse returns the auth code from the GetAuthCodeForDomain funtion.

type AutorenewEnabled

type AutorenewEnabled = bool

AutorenewEnabled Indicates whether the domain is set to renew automatically before expiration.

type AvailabilityRequest

type AvailabilityRequest struct {
	// DomainNames DomainNames is the list of domains to check if they are available.
	DomainNames []string `json:"domainNames"`
}

AvailabilityRequest Checks if one or more domain names are available for registration (up to 50 domains). Important: Do not encode the `:` in the path. Use `/core/v1/domains:checkAvailability`, not `/core/v1/domains%3AcheckAvailability`.

type AvailableWebhooks

type AvailableWebhooks string

AvailableWebhooks The list of configured webhooks you can subscribe to

const (
	AvailableWebhooksAccountCreditBalanceChange AvailableWebhooks = "account.credit.balance_change"
	AvailableWebhooksDomainLockStatusChange     AvailableWebhooks = "domain.lock.status_change"
	AvailableWebhooksDomainTransferStatusChange AvailableWebhooks = "domain.transfer.status_change"
)

Defines values for AvailableWebhooks.

type BadGateway502

type BadGateway502 struct {
	// Message A human-readable message providing more details about the error
	Message string `json:"message"`
}

BadGateway502 defines model for BadGateway502.

type CancelTransferResp

type CancelTransferResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Transfer
	JSON400      *GenericError500
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseCancelTransferResp

func ParseCancelTransferResp(rsp *http.Response) (*CancelTransferResp, error)

ParseCancelTransferResp parses an HTTP response from a CancelTransferWithResponse call

func (CancelTransferResp) Status

func (r CancelTransferResp) Status() string

Status returns HTTPResponse.Status

func (CancelTransferResp) StatusCode

func (r CancelTransferResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CheckAccountBalanceResp

type CheckAccountBalanceResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CheckAccountBalanceResponse
	JSON401      *Unauthorized401
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseCheckAccountBalanceResp

func ParseCheckAccountBalanceResp(rsp *http.Response) (*CheckAccountBalanceResp, error)

ParseCheckAccountBalanceResp parses an HTTP response from a CheckAccountBalanceWithResponse call

func (CheckAccountBalanceResp) Status

func (r CheckAccountBalanceResp) Status() string

Status returns HTTPResponse.Status

func (CheckAccountBalanceResp) StatusCode

func (r CheckAccountBalanceResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CheckAccountBalanceResponse

type CheckAccountBalanceResponse struct {
	// Balance Balance is the current account balance in USD.
	Balance float64 `json:"balance"`
}

CheckAccountBalanceResponse defines model for CheckAccountBalanceResponse.

type CheckAvailabilityJSONRequestBody

type CheckAvailabilityJSONRequestBody = AvailabilityRequest

CheckAvailabilityJSONRequestBody defines body for CheckAvailability for application/json ContentType.

type CheckAvailabilityResp

type CheckAvailabilityResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SearchResponse
	JSON401      *Unauthorized401
	JSON415      *UnsupportedMedia415
	JSON422      *UnprocessableEntity422
	JSON429      *TooManyRequests429
	JSON502      *BadGateway502
}

func ParseCheckAvailabilityResp

func ParseCheckAvailabilityResp(rsp *http.Response) (*CheckAvailabilityResp, error)

ParseCheckAvailabilityResp parses an HTTP response from a CheckAvailabilityWithResponse call

func (CheckAvailabilityResp) Status

func (r CheckAvailabilityResp) Status() string

Status returns HTTPResponse.Status

func (CheckAvailabilityResp) StatusCode

func (r CheckAvailabilityResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CancelTransfer

func (c *Client) CancelTransfer(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CheckAccountBalance

func (c *Client) CheckAccountBalance(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CheckAvailability

func (c *Client) CheckAvailability(ctx context.Context, body CheckAvailabilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CheckAvailabilityWithBody

func (c *Client) CheckAvailabilityWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateAccount

func (c *Client) CreateAccount(ctx context.Context, body CreateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateAccountWithBody

func (c *Client) CreateAccountWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDNSSEC

func (c *Client) CreateDNSSEC(ctx context.Context, domainName string, body CreateDNSSECJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDNSSECWithBody

func (c *Client) CreateDNSSECWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDomain

func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainParams, body CreateDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDomainWithBody

func (c *Client) CreateDomainWithBody(ctx context.Context, params *CreateDomainParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEmailForwarding

func (c *Client) CreateEmailForwarding(ctx context.Context, domainName string, body CreateEmailForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEmailForwardingWithBody

func (c *Client) CreateEmailForwardingWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateRecord

func (c *Client) CreateRecord(ctx context.Context, domainName string, body CreateRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateRecordWithBody

func (c *Client) CreateRecordWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTransfer

func (c *Client) CreateTransfer(ctx context.Context, body CreateTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTransferWithBody

func (c *Client) CreateTransferWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateURLForwarding

func (c *Client) CreateURLForwarding(ctx context.Context, domainName string, body CreateURLForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateURLForwardingWithBody

func (c *Client) CreateURLForwardingWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVanityNameserver

func (c *Client) CreateVanityNameserver(ctx context.Context, domainName string, body CreateVanityNameserverJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVanityNameserverWithBody

func (c *Client) CreateVanityNameserverWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteDNSSEC

func (c *Client) DeleteDNSSEC(ctx context.Context, domainName string, digest string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteEmailForwarding

func (c *Client) DeleteEmailForwarding(ctx context.Context, domainName string, emailBox string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteRecord

func (c *Client) DeleteRecord(ctx context.Context, domainName string, id int32, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteSubscription

func (c *Client) DeleteSubscription(ctx context.Context, id int32, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteURLForwarding

func (c *Client) DeleteURLForwarding(ctx context.Context, domainName string, host string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteVanityNameserver

func (c *Client) DeleteVanityNameserver(ctx context.Context, domainName string, hostname string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DisableAutorenew

func (c *Client) DisableAutorenew(ctx context.Context, domainName string, params *DisableAutorenewParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DisableWhoisPrivacy

func (c *Client) DisableWhoisPrivacy(ctx context.Context, domainName string, params *DisableWhoisPrivacyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) EnableAutorenew

func (c *Client) EnableAutorenew(ctx context.Context, domainName string, params *EnableAutorenewParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) EnableWhoisPrivacy

func (c *Client) EnableWhoisPrivacy(ctx context.Context, domainName string, params *EnableWhoisPrivacyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAuthCodeForDomain

func (c *Client) GetAuthCodeForDomain(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDNSSEC

func (c *Client) GetDNSSEC(ctx context.Context, domainName string, digest string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDomain

func (c *Client) GetDomain(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetEmailForwarding

func (c *Client) GetEmailForwarding(ctx context.Context, domainName string, emailBox string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetOrder

func (c *Client) GetOrder(ctx context.Context, orderId int32, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetPricingForDomain

func (c *Client) GetPricingForDomain(ctx context.Context, domainName string, params *GetPricingForDomainParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRecord

func (c *Client) GetRecord(ctx context.Context, domainName string, id int32, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRequirement

func (c *Client) GetRequirement(ctx context.Context, tld string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSubscribedNotifications

func (c *Client) GetSubscribedNotifications(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTransfer

func (c *Client) GetTransfer(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetURLForwarding

func (c *Client) GetURLForwarding(ctx context.Context, domainName string, host string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetVanityNameserver

func (c *Client) GetVanityNameserver(ctx context.Context, domainName string, hostname string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Hello

func (c *Client) Hello(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListDNSSECs

func (c *Client) ListDNSSECs(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListDomains

func (c *Client) ListDomains(ctx context.Context, params *ListDomainsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListEmailForwardings

func (c *Client) ListEmailForwardings(ctx context.Context, domainName string, params *ListEmailForwardingsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListOrders

func (c *Client) ListOrders(ctx context.Context, params *ListOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListRecords

func (c *Client) ListRecords(ctx context.Context, domainName string, params *ListRecordsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListTransfers

func (c *Client) ListTransfers(ctx context.Context, params *ListTransfersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListURLForwardings

func (c *Client) ListURLForwardings(ctx context.Context, domainName string, params *ListURLForwardingsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListVanityNameservers

func (c *Client) ListVanityNameservers(ctx context.Context, domainName string, params *ListVanityNameserversParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) LockDomain

func (c *Client) LockDomain(ctx context.Context, domainName string, params *LockDomainParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ModifySubscription

func (c *Client) ModifySubscription(ctx context.Context, id int32, body ModifySubscriptionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ModifySubscriptionWithBody

func (c *Client) ModifySubscriptionWithBody(ctx context.Context, id int32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PremiumDomainLists

func (c *Client) PremiumDomainLists(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PurchasePrivacy

func (c *Client) PurchasePrivacy(ctx context.Context, domainName string, params *PurchasePrivacyParams, body PurchasePrivacyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PurchasePrivacyWithBody

func (c *Client) PurchasePrivacyWithBody(ctx context.Context, domainName string, params *PurchasePrivacyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RenewDomain

func (c *Client) RenewDomain(ctx context.Context, domainName string, body RenewDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RenewDomainWithBody

func (c *Client) RenewDomainWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Search

func (c *Client) Search(ctx context.Context, body SearchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchWithBody

func (c *Client) SearchWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SetContacts

func (c *Client) SetContacts(ctx context.Context, domainName string, body SetContactsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SetContactsWithBody

func (c *Client) SetContactsWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SetNameservers

func (c *Client) SetNameservers(ctx context.Context, domainName string, body SetNameserversJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SetNameserversWithBody

func (c *Client) SetNameserversWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SubscribeToNotification

func (c *Client) SubscribeToNotification(ctx context.Context, body SubscribeToNotificationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SubscribeToNotificationWithBody

func (c *Client) SubscribeToNotificationWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) TldPriceList

func (c *Client) TldPriceList(ctx context.Context, params *TldPriceListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UnlockDomain

func (c *Client) UnlockDomain(ctx context.Context, domainName string, params *UnlockDomainParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UnverifiedContactsList

func (c *Client) UnverifiedContactsList(ctx context.Context, params *UnverifiedContactsListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDomain

func (c *Client) UpdateDomain(ctx context.Context, domainName string, body UpdateDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDomainWithBody

func (c *Client) UpdateDomainWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateEmailForwarding

func (c *Client) UpdateEmailForwarding(ctx context.Context, domainName string, emailBox string, body UpdateEmailForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateEmailForwardingWithBody

func (c *Client) UpdateEmailForwardingWithBody(ctx context.Context, domainName string, emailBox string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateRecord

func (c *Client) UpdateRecord(ctx context.Context, domainName string, id int32, body UpdateRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateRecordWithBody

func (c *Client) UpdateRecordWithBody(ctx context.Context, domainName string, id int32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateURLForwarding

func (c *Client) UpdateURLForwarding(ctx context.Context, domainName string, host string, body UpdateURLForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateURLForwardingWithBody

func (c *Client) UpdateURLForwardingWithBody(ctx context.Context, domainName string, host string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateVanityNameserver

func (c *Client) UpdateVanityNameserver(ctx context.Context, domainName string, hostname string, body UpdateVanityNameserverJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateVanityNameserverWithBody

func (c *Client) UpdateVanityNameserverWithBody(ctx context.Context, domainName string, hostname string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) VerifyContact

func (c *Client) VerifyContact(ctx context.Context, verificationId int32, params *VerifyContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ZoneCheck

func (c *Client) ZoneCheck(ctx context.Context, body ZoneCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ZoneCheckWithBody

func (c *Client) ZoneCheckWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// CheckAccountBalance request
	CheckAccountBalance(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateAccountWithBody request with any body
	CreateAccountWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateAccount(ctx context.Context, body CreateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UnverifiedContactsList request
	UnverifiedContactsList(ctx context.Context, params *UnverifiedContactsListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// VerifyContact request
	VerifyContact(ctx context.Context, verificationId int32, params *VerifyContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRequirement request
	GetRequirement(ctx context.Context, tld string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListDomains request
	ListDomains(ctx context.Context, params *ListDomainsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDomainWithBody request with any body
	CreateDomainWithBody(ctx context.Context, params *CreateDomainParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDomain(ctx context.Context, params *CreateDomainParams, body CreateDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDomain request
	GetDomain(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateDomainWithBody request with any body
	UpdateDomainWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateDomain(ctx context.Context, domainName string, body UpdateDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListDNSSECs request
	ListDNSSECs(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDNSSECWithBody request with any body
	CreateDNSSECWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDNSSEC(ctx context.Context, domainName string, body CreateDNSSECJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteDNSSEC request
	DeleteDNSSEC(ctx context.Context, domainName string, digest string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDNSSEC request
	GetDNSSEC(ctx context.Context, domainName string, digest string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListEmailForwardings request
	ListEmailForwardings(ctx context.Context, domainName string, params *ListEmailForwardingsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateEmailForwardingWithBody request with any body
	CreateEmailForwardingWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateEmailForwarding(ctx context.Context, domainName string, body CreateEmailForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteEmailForwarding request
	DeleteEmailForwarding(ctx context.Context, domainName string, emailBox string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEmailForwarding request
	GetEmailForwarding(ctx context.Context, domainName string, emailBox string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateEmailForwardingWithBody request with any body
	UpdateEmailForwardingWithBody(ctx context.Context, domainName string, emailBox string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateEmailForwarding(ctx context.Context, domainName string, emailBox string, body UpdateEmailForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListRecords request
	ListRecords(ctx context.Context, domainName string, params *ListRecordsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRecordWithBody request with any body
	CreateRecordWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateRecord(ctx context.Context, domainName string, body CreateRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteRecord request
	DeleteRecord(ctx context.Context, domainName string, id int32, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRecord request
	GetRecord(ctx context.Context, domainName string, id int32, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateRecordWithBody request with any body
	UpdateRecordWithBody(ctx context.Context, domainName string, id int32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateRecord(ctx context.Context, domainName string, id int32, body UpdateRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListURLForwardings request
	ListURLForwardings(ctx context.Context, domainName string, params *ListURLForwardingsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateURLForwardingWithBody request with any body
	CreateURLForwardingWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateURLForwarding(ctx context.Context, domainName string, body CreateURLForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteURLForwarding request
	DeleteURLForwarding(ctx context.Context, domainName string, host string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetURLForwarding request
	GetURLForwarding(ctx context.Context, domainName string, host string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateURLForwardingWithBody request with any body
	UpdateURLForwardingWithBody(ctx context.Context, domainName string, host string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateURLForwarding(ctx context.Context, domainName string, host string, body UpdateURLForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListVanityNameservers request
	ListVanityNameservers(ctx context.Context, domainName string, params *ListVanityNameserversParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateVanityNameserverWithBody request with any body
	CreateVanityNameserverWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateVanityNameserver(ctx context.Context, domainName string, body CreateVanityNameserverJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteVanityNameserver request
	DeleteVanityNameserver(ctx context.Context, domainName string, hostname string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVanityNameserver request
	GetVanityNameserver(ctx context.Context, domainName string, hostname string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateVanityNameserverWithBody request with any body
	UpdateVanityNameserverWithBody(ctx context.Context, domainName string, hostname string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateVanityNameserver(ctx context.Context, domainName string, hostname string, body UpdateVanityNameserverJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DisableAutorenew request
	DisableAutorenew(ctx context.Context, domainName string, params *DisableAutorenewParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DisableWhoisPrivacy request
	DisableWhoisPrivacy(ctx context.Context, domainName string, params *DisableWhoisPrivacyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EnableAutorenew request
	EnableAutorenew(ctx context.Context, domainName string, params *EnableAutorenewParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EnableWhoisPrivacy request
	EnableWhoisPrivacy(ctx context.Context, domainName string, params *EnableWhoisPrivacyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAuthCodeForDomain request
	GetAuthCodeForDomain(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPricingForDomain request
	GetPricingForDomain(ctx context.Context, domainName string, params *GetPricingForDomainParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LockDomain request
	LockDomain(ctx context.Context, domainName string, params *LockDomainParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PurchasePrivacyWithBody request with any body
	PurchasePrivacyWithBody(ctx context.Context, domainName string, params *PurchasePrivacyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PurchasePrivacy(ctx context.Context, domainName string, params *PurchasePrivacyParams, body PurchasePrivacyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RenewDomainWithBody request with any body
	RenewDomainWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	RenewDomain(ctx context.Context, domainName string, body RenewDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetContactsWithBody request with any body
	SetContactsWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SetContacts(ctx context.Context, domainName string, body SetContactsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetNameserversWithBody request with any body
	SetNameserversWithBody(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SetNameservers(ctx context.Context, domainName string, body SetNameserversJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UnlockDomain request
	UnlockDomain(ctx context.Context, domainName string, params *UnlockDomainParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CheckAvailabilityWithBody request with any body
	CheckAvailabilityWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CheckAvailability(ctx context.Context, body CheckAvailabilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchWithBody request with any body
	SearchWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	Search(ctx context.Context, body SearchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Hello request
	Hello(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSubscribedNotifications request
	GetSubscribedNotifications(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SubscribeToNotificationWithBody request with any body
	SubscribeToNotificationWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SubscribeToNotification(ctx context.Context, body SubscribeToNotificationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteSubscription request
	DeleteSubscription(ctx context.Context, id int32, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ModifySubscriptionWithBody request with any body
	ModifySubscriptionWithBody(ctx context.Context, id int32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ModifySubscription(ctx context.Context, id int32, body ModifySubscriptionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListOrders request
	ListOrders(ctx context.Context, params *ListOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrder request
	GetOrder(ctx context.Context, orderId int32, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PremiumDomainLists request
	PremiumDomainLists(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TldPriceList request
	TldPriceList(ctx context.Context, params *TldPriceListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListTransfers request
	ListTransfers(ctx context.Context, params *ListTransfersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateTransferWithBody request with any body
	CreateTransferWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateTransfer(ctx context.Context, body CreateTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTransfer request
	GetTransfer(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CancelTransfer request
	CancelTransfer(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ZoneCheckWithBody request with any body
	ZoneCheckWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ZoneCheck(ctx context.Context, body ZoneCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CancelTransferWithResponse

func (c *ClientWithResponses) CancelTransferWithResponse(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*CancelTransferResp, error)

CancelTransferWithResponse request returning *CancelTransferResp

func (*ClientWithResponses) CheckAccountBalanceWithResponse

func (c *ClientWithResponses) CheckAccountBalanceWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*CheckAccountBalanceResp, error)

CheckAccountBalanceWithResponse request returning *CheckAccountBalanceResp

func (*ClientWithResponses) CheckAvailabilityWithBodyWithResponse

func (c *ClientWithResponses) CheckAvailabilityWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CheckAvailabilityResp, error)

CheckAvailabilityWithBodyWithResponse request with arbitrary body returning *CheckAvailabilityResp

func (*ClientWithResponses) CheckAvailabilityWithResponse

func (c *ClientWithResponses) CheckAvailabilityWithResponse(ctx context.Context, body CheckAvailabilityJSONRequestBody, reqEditors ...RequestEditorFn) (*CheckAvailabilityResp, error)

func (*ClientWithResponses) CreateAccountWithBodyWithResponse

func (c *ClientWithResponses) CreateAccountWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAccountResp, error)

CreateAccountWithBodyWithResponse request with arbitrary body returning *CreateAccountResp

func (*ClientWithResponses) CreateAccountWithResponse

func (c *ClientWithResponses) CreateAccountWithResponse(ctx context.Context, body CreateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAccountResp, error)

func (*ClientWithResponses) CreateDNSSECWithBodyWithResponse

func (c *ClientWithResponses) CreateDNSSECWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDNSSECResp, error)

CreateDNSSECWithBodyWithResponse request with arbitrary body returning *CreateDNSSECResp

func (*ClientWithResponses) CreateDNSSECWithResponse

func (c *ClientWithResponses) CreateDNSSECWithResponse(ctx context.Context, domainName string, body CreateDNSSECJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDNSSECResp, error)

func (*ClientWithResponses) CreateDomainWithBodyWithResponse

func (c *ClientWithResponses) CreateDomainWithBodyWithResponse(ctx context.Context, params *CreateDomainParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDomainResp, error)

CreateDomainWithBodyWithResponse request with arbitrary body returning *CreateDomainResp

func (*ClientWithResponses) CreateDomainWithResponse

func (c *ClientWithResponses) CreateDomainWithResponse(ctx context.Context, params *CreateDomainParams, body CreateDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDomainResp, error)

func (*ClientWithResponses) CreateEmailForwardingWithBodyWithResponse

func (c *ClientWithResponses) CreateEmailForwardingWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEmailForwardingResp, error)

CreateEmailForwardingWithBodyWithResponse request with arbitrary body returning *CreateEmailForwardingResp

func (*ClientWithResponses) CreateEmailForwardingWithResponse

func (c *ClientWithResponses) CreateEmailForwardingWithResponse(ctx context.Context, domainName string, body CreateEmailForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEmailForwardingResp, error)

func (*ClientWithResponses) CreateRecordWithBodyWithResponse

func (c *ClientWithResponses) CreateRecordWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRecordResp, error)

CreateRecordWithBodyWithResponse request with arbitrary body returning *CreateRecordResp

func (*ClientWithResponses) CreateRecordWithResponse

func (c *ClientWithResponses) CreateRecordWithResponse(ctx context.Context, domainName string, body CreateRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRecordResp, error)

func (*ClientWithResponses) CreateTransferWithBodyWithResponse

func (c *ClientWithResponses) CreateTransferWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTransferResp, error)

CreateTransferWithBodyWithResponse request with arbitrary body returning *CreateTransferResp

func (*ClientWithResponses) CreateTransferWithResponse

func (c *ClientWithResponses) CreateTransferWithResponse(ctx context.Context, body CreateTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTransferResp, error)

func (*ClientWithResponses) CreateURLForwardingWithBodyWithResponse

func (c *ClientWithResponses) CreateURLForwardingWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateURLForwardingResp, error)

CreateURLForwardingWithBodyWithResponse request with arbitrary body returning *CreateURLForwardingResp

func (*ClientWithResponses) CreateURLForwardingWithResponse

func (c *ClientWithResponses) CreateURLForwardingWithResponse(ctx context.Context, domainName string, body CreateURLForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateURLForwardingResp, error)

func (*ClientWithResponses) CreateVanityNameserverWithBodyWithResponse

func (c *ClientWithResponses) CreateVanityNameserverWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVanityNameserverResp, error)

CreateVanityNameserverWithBodyWithResponse request with arbitrary body returning *CreateVanityNameserverResp

func (*ClientWithResponses) CreateVanityNameserverWithResponse

func (c *ClientWithResponses) CreateVanityNameserverWithResponse(ctx context.Context, domainName string, body CreateVanityNameserverJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVanityNameserverResp, error)

func (*ClientWithResponses) DeleteDNSSECWithResponse

func (c *ClientWithResponses) DeleteDNSSECWithResponse(ctx context.Context, domainName string, digest string, reqEditors ...RequestEditorFn) (*DeleteDNSSECResp, error)

DeleteDNSSECWithResponse request returning *DeleteDNSSECResp

func (*ClientWithResponses) DeleteEmailForwardingWithResponse

func (c *ClientWithResponses) DeleteEmailForwardingWithResponse(ctx context.Context, domainName string, emailBox string, reqEditors ...RequestEditorFn) (*DeleteEmailForwardingResp, error)

DeleteEmailForwardingWithResponse request returning *DeleteEmailForwardingResp

func (*ClientWithResponses) DeleteRecordWithResponse

func (c *ClientWithResponses) DeleteRecordWithResponse(ctx context.Context, domainName string, id int32, reqEditors ...RequestEditorFn) (*DeleteRecordResp, error)

DeleteRecordWithResponse request returning *DeleteRecordResp

func (*ClientWithResponses) DeleteSubscriptionWithResponse

func (c *ClientWithResponses) DeleteSubscriptionWithResponse(ctx context.Context, id int32, reqEditors ...RequestEditorFn) (*DeleteSubscriptionResp, error)

DeleteSubscriptionWithResponse request returning *DeleteSubscriptionResp

func (*ClientWithResponses) DeleteURLForwardingWithResponse

func (c *ClientWithResponses) DeleteURLForwardingWithResponse(ctx context.Context, domainName string, host string, reqEditors ...RequestEditorFn) (*DeleteURLForwardingResp, error)

DeleteURLForwardingWithResponse request returning *DeleteURLForwardingResp

func (*ClientWithResponses) DeleteVanityNameserverWithResponse

func (c *ClientWithResponses) DeleteVanityNameserverWithResponse(ctx context.Context, domainName string, hostname string, reqEditors ...RequestEditorFn) (*DeleteVanityNameserverResp, error)

DeleteVanityNameserverWithResponse request returning *DeleteVanityNameserverResp

func (*ClientWithResponses) DisableAutorenewWithResponse

func (c *ClientWithResponses) DisableAutorenewWithResponse(ctx context.Context, domainName string, params *DisableAutorenewParams, reqEditors ...RequestEditorFn) (*DisableAutorenewResp, error)

DisableAutorenewWithResponse request returning *DisableAutorenewResp

func (*ClientWithResponses) DisableWhoisPrivacyWithResponse

func (c *ClientWithResponses) DisableWhoisPrivacyWithResponse(ctx context.Context, domainName string, params *DisableWhoisPrivacyParams, reqEditors ...RequestEditorFn) (*DisableWhoisPrivacyResp, error)

DisableWhoisPrivacyWithResponse request returning *DisableWhoisPrivacyResp

func (*ClientWithResponses) EnableAutorenewWithResponse

func (c *ClientWithResponses) EnableAutorenewWithResponse(ctx context.Context, domainName string, params *EnableAutorenewParams, reqEditors ...RequestEditorFn) (*EnableAutorenewResp, error)

EnableAutorenewWithResponse request returning *EnableAutorenewResp

func (*ClientWithResponses) EnableWhoisPrivacyWithResponse

func (c *ClientWithResponses) EnableWhoisPrivacyWithResponse(ctx context.Context, domainName string, params *EnableWhoisPrivacyParams, reqEditors ...RequestEditorFn) (*EnableWhoisPrivacyResp, error)

EnableWhoisPrivacyWithResponse request returning *EnableWhoisPrivacyResp

func (*ClientWithResponses) GetAuthCodeForDomainWithResponse

func (c *ClientWithResponses) GetAuthCodeForDomainWithResponse(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*GetAuthCodeForDomainResp, error)

GetAuthCodeForDomainWithResponse request returning *GetAuthCodeForDomainResp

func (*ClientWithResponses) GetDNSSECWithResponse

func (c *ClientWithResponses) GetDNSSECWithResponse(ctx context.Context, domainName string, digest string, reqEditors ...RequestEditorFn) (*GetDNSSECResp, error)

GetDNSSECWithResponse request returning *GetDNSSECResp

func (*ClientWithResponses) GetDomainWithResponse

func (c *ClientWithResponses) GetDomainWithResponse(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*GetDomainResp, error)

GetDomainWithResponse request returning *GetDomainResp

func (*ClientWithResponses) GetEmailForwardingWithResponse

func (c *ClientWithResponses) GetEmailForwardingWithResponse(ctx context.Context, domainName string, emailBox string, reqEditors ...RequestEditorFn) (*GetEmailForwardingResp, error)

GetEmailForwardingWithResponse request returning *GetEmailForwardingResp

func (*ClientWithResponses) GetOrderWithResponse

func (c *ClientWithResponses) GetOrderWithResponse(ctx context.Context, orderId int32, reqEditors ...RequestEditorFn) (*GetOrderResp, error)

GetOrderWithResponse request returning *GetOrderResp

func (*ClientWithResponses) GetPricingForDomainWithResponse

func (c *ClientWithResponses) GetPricingForDomainWithResponse(ctx context.Context, domainName string, params *GetPricingForDomainParams, reqEditors ...RequestEditorFn) (*GetPricingForDomainResp, error)

GetPricingForDomainWithResponse request returning *GetPricingForDomainResp

func (*ClientWithResponses) GetRecordWithResponse

func (c *ClientWithResponses) GetRecordWithResponse(ctx context.Context, domainName string, id int32, reqEditors ...RequestEditorFn) (*GetRecordResp, error)

GetRecordWithResponse request returning *GetRecordResp

func (*ClientWithResponses) GetRequirementWithResponse

func (c *ClientWithResponses) GetRequirementWithResponse(ctx context.Context, tld string, reqEditors ...RequestEditorFn) (*GetRequirementResp, error)

GetRequirementWithResponse request returning *GetRequirementResp

func (*ClientWithResponses) GetSubscribedNotificationsWithResponse

func (c *ClientWithResponses) GetSubscribedNotificationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSubscribedNotificationsResp, error)

GetSubscribedNotificationsWithResponse request returning *GetSubscribedNotificationsResp

func (*ClientWithResponses) GetTransferWithResponse

func (c *ClientWithResponses) GetTransferWithResponse(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*GetTransferResp, error)

GetTransferWithResponse request returning *GetTransferResp

func (*ClientWithResponses) GetURLForwardingWithResponse

func (c *ClientWithResponses) GetURLForwardingWithResponse(ctx context.Context, domainName string, host string, reqEditors ...RequestEditorFn) (*GetURLForwardingResp, error)

GetURLForwardingWithResponse request returning *GetURLForwardingResp

func (*ClientWithResponses) GetVanityNameserverWithResponse

func (c *ClientWithResponses) GetVanityNameserverWithResponse(ctx context.Context, domainName string, hostname string, reqEditors ...RequestEditorFn) (*GetVanityNameserverResp, error)

GetVanityNameserverWithResponse request returning *GetVanityNameserverResp

func (*ClientWithResponses) HelloWithResponse

func (c *ClientWithResponses) HelloWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HelloResp, error)

HelloWithResponse request returning *HelloResp

func (*ClientWithResponses) ListDNSSECsWithResponse

func (c *ClientWithResponses) ListDNSSECsWithResponse(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*ListDNSSECsResp, error)

ListDNSSECsWithResponse request returning *ListDNSSECsResp

func (*ClientWithResponses) ListDomainsWithResponse

func (c *ClientWithResponses) ListDomainsWithResponse(ctx context.Context, params *ListDomainsParams, reqEditors ...RequestEditorFn) (*ListDomainsResp, error)

ListDomainsWithResponse request returning *ListDomainsResp

func (*ClientWithResponses) ListEmailForwardingsWithResponse

func (c *ClientWithResponses) ListEmailForwardingsWithResponse(ctx context.Context, domainName string, params *ListEmailForwardingsParams, reqEditors ...RequestEditorFn) (*ListEmailForwardingsResp, error)

ListEmailForwardingsWithResponse request returning *ListEmailForwardingsResp

func (*ClientWithResponses) ListOrdersWithResponse

func (c *ClientWithResponses) ListOrdersWithResponse(ctx context.Context, params *ListOrdersParams, reqEditors ...RequestEditorFn) (*ListOrdersResp, error)

ListOrdersWithResponse request returning *ListOrdersResp

func (*ClientWithResponses) ListRecordsWithResponse

func (c *ClientWithResponses) ListRecordsWithResponse(ctx context.Context, domainName string, params *ListRecordsParams, reqEditors ...RequestEditorFn) (*ListRecordsResp, error)

ListRecordsWithResponse request returning *ListRecordsResp

func (*ClientWithResponses) ListTransfersWithResponse

func (c *ClientWithResponses) ListTransfersWithResponse(ctx context.Context, params *ListTransfersParams, reqEditors ...RequestEditorFn) (*ListTransfersResp, error)

ListTransfersWithResponse request returning *ListTransfersResp

func (*ClientWithResponses) ListURLForwardingsWithResponse

func (c *ClientWithResponses) ListURLForwardingsWithResponse(ctx context.Context, domainName string, params *ListURLForwardingsParams, reqEditors ...RequestEditorFn) (*ListURLForwardingsResp, error)

ListURLForwardingsWithResponse request returning *ListURLForwardingsResp

func (*ClientWithResponses) ListVanityNameserversWithResponse

func (c *ClientWithResponses) ListVanityNameserversWithResponse(ctx context.Context, domainName string, params *ListVanityNameserversParams, reqEditors ...RequestEditorFn) (*ListVanityNameserversResp, error)

ListVanityNameserversWithResponse request returning *ListVanityNameserversResp

func (*ClientWithResponses) LockDomainWithResponse

func (c *ClientWithResponses) LockDomainWithResponse(ctx context.Context, domainName string, params *LockDomainParams, reqEditors ...RequestEditorFn) (*LockDomainResp, error)

LockDomainWithResponse request returning *LockDomainResp

func (*ClientWithResponses) ModifySubscriptionWithBodyWithResponse

func (c *ClientWithResponses) ModifySubscriptionWithBodyWithResponse(ctx context.Context, id int32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ModifySubscriptionResp, error)

ModifySubscriptionWithBodyWithResponse request with arbitrary body returning *ModifySubscriptionResp

func (*ClientWithResponses) ModifySubscriptionWithResponse

func (c *ClientWithResponses) ModifySubscriptionWithResponse(ctx context.Context, id int32, body ModifySubscriptionJSONRequestBody, reqEditors ...RequestEditorFn) (*ModifySubscriptionResp, error)

func (*ClientWithResponses) PremiumDomainListsWithResponse

func (c *ClientWithResponses) PremiumDomainListsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PremiumDomainListsResp, error)

PremiumDomainListsWithResponse request returning *PremiumDomainListsResp

func (*ClientWithResponses) PurchasePrivacyWithBodyWithResponse

func (c *ClientWithResponses) PurchasePrivacyWithBodyWithResponse(ctx context.Context, domainName string, params *PurchasePrivacyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PurchasePrivacyResp, error)

PurchasePrivacyWithBodyWithResponse request with arbitrary body returning *PurchasePrivacyResp

func (*ClientWithResponses) PurchasePrivacyWithResponse

func (c *ClientWithResponses) PurchasePrivacyWithResponse(ctx context.Context, domainName string, params *PurchasePrivacyParams, body PurchasePrivacyJSONRequestBody, reqEditors ...RequestEditorFn) (*PurchasePrivacyResp, error)

func (*ClientWithResponses) RenewDomainWithBodyWithResponse

func (c *ClientWithResponses) RenewDomainWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RenewDomainResp, error)

RenewDomainWithBodyWithResponse request with arbitrary body returning *RenewDomainResp

func (*ClientWithResponses) RenewDomainWithResponse

func (c *ClientWithResponses) RenewDomainWithResponse(ctx context.Context, domainName string, body RenewDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*RenewDomainResp, error)

func (*ClientWithResponses) SearchWithBodyWithResponse

func (c *ClientWithResponses) SearchWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchResp, error)

SearchWithBodyWithResponse request with arbitrary body returning *SearchResp

func (*ClientWithResponses) SearchWithResponse

func (c *ClientWithResponses) SearchWithResponse(ctx context.Context, body SearchJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchResp, error)

func (*ClientWithResponses) SetContactsWithBodyWithResponse

func (c *ClientWithResponses) SetContactsWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetContactsResp, error)

SetContactsWithBodyWithResponse request with arbitrary body returning *SetContactsResp

func (*ClientWithResponses) SetContactsWithResponse

func (c *ClientWithResponses) SetContactsWithResponse(ctx context.Context, domainName string, body SetContactsJSONRequestBody, reqEditors ...RequestEditorFn) (*SetContactsResp, error)

func (*ClientWithResponses) SetNameserversWithBodyWithResponse

func (c *ClientWithResponses) SetNameserversWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetNameserversResp, error)

SetNameserversWithBodyWithResponse request with arbitrary body returning *SetNameserversResp

func (*ClientWithResponses) SetNameserversWithResponse

func (c *ClientWithResponses) SetNameserversWithResponse(ctx context.Context, domainName string, body SetNameserversJSONRequestBody, reqEditors ...RequestEditorFn) (*SetNameserversResp, error)

func (*ClientWithResponses) SubscribeToNotificationWithBodyWithResponse

func (c *ClientWithResponses) SubscribeToNotificationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubscribeToNotificationResp, error)

SubscribeToNotificationWithBodyWithResponse request with arbitrary body returning *SubscribeToNotificationResp

func (*ClientWithResponses) SubscribeToNotificationWithResponse

func (c *ClientWithResponses) SubscribeToNotificationWithResponse(ctx context.Context, body SubscribeToNotificationJSONRequestBody, reqEditors ...RequestEditorFn) (*SubscribeToNotificationResp, error)

func (*ClientWithResponses) TldPriceListWithResponse

func (c *ClientWithResponses) TldPriceListWithResponse(ctx context.Context, params *TldPriceListParams, reqEditors ...RequestEditorFn) (*TldPriceListResp, error)

TldPriceListWithResponse request returning *TldPriceListResp

func (*ClientWithResponses) UnlockDomainWithResponse

func (c *ClientWithResponses) UnlockDomainWithResponse(ctx context.Context, domainName string, params *UnlockDomainParams, reqEditors ...RequestEditorFn) (*UnlockDomainResp, error)

UnlockDomainWithResponse request returning *UnlockDomainResp

func (*ClientWithResponses) UnverifiedContactsListWithResponse

func (c *ClientWithResponses) UnverifiedContactsListWithResponse(ctx context.Context, params *UnverifiedContactsListParams, reqEditors ...RequestEditorFn) (*UnverifiedContactsListResp, error)

UnverifiedContactsListWithResponse request returning *UnverifiedContactsListResp

func (*ClientWithResponses) UpdateDomainWithBodyWithResponse

func (c *ClientWithResponses) UpdateDomainWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDomainResp, error)

UpdateDomainWithBodyWithResponse request with arbitrary body returning *UpdateDomainResp

func (*ClientWithResponses) UpdateDomainWithResponse

func (c *ClientWithResponses) UpdateDomainWithResponse(ctx context.Context, domainName string, body UpdateDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDomainResp, error)

func (*ClientWithResponses) UpdateEmailForwardingWithBodyWithResponse

func (c *ClientWithResponses) UpdateEmailForwardingWithBodyWithResponse(ctx context.Context, domainName string, emailBox string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateEmailForwardingResp, error)

UpdateEmailForwardingWithBodyWithResponse request with arbitrary body returning *UpdateEmailForwardingResp

func (*ClientWithResponses) UpdateEmailForwardingWithResponse

func (c *ClientWithResponses) UpdateEmailForwardingWithResponse(ctx context.Context, domainName string, emailBox string, body UpdateEmailForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateEmailForwardingResp, error)

func (*ClientWithResponses) UpdateRecordWithBodyWithResponse

func (c *ClientWithResponses) UpdateRecordWithBodyWithResponse(ctx context.Context, domainName string, id int32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRecordResp, error)

UpdateRecordWithBodyWithResponse request with arbitrary body returning *UpdateRecordResp

func (*ClientWithResponses) UpdateRecordWithResponse

func (c *ClientWithResponses) UpdateRecordWithResponse(ctx context.Context, domainName string, id int32, body UpdateRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRecordResp, error)

func (*ClientWithResponses) UpdateURLForwardingWithBodyWithResponse

func (c *ClientWithResponses) UpdateURLForwardingWithBodyWithResponse(ctx context.Context, domainName string, host string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateURLForwardingResp, error)

UpdateURLForwardingWithBodyWithResponse request with arbitrary body returning *UpdateURLForwardingResp

func (*ClientWithResponses) UpdateURLForwardingWithResponse

func (c *ClientWithResponses) UpdateURLForwardingWithResponse(ctx context.Context, domainName string, host string, body UpdateURLForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateURLForwardingResp, error)

func (*ClientWithResponses) UpdateVanityNameserverWithBodyWithResponse

func (c *ClientWithResponses) UpdateVanityNameserverWithBodyWithResponse(ctx context.Context, domainName string, hostname string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateVanityNameserverResp, error)

UpdateVanityNameserverWithBodyWithResponse request with arbitrary body returning *UpdateVanityNameserverResp

func (*ClientWithResponses) UpdateVanityNameserverWithResponse

func (c *ClientWithResponses) UpdateVanityNameserverWithResponse(ctx context.Context, domainName string, hostname string, body UpdateVanityNameserverJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateVanityNameserverResp, error)

func (*ClientWithResponses) VerifyContactWithResponse

func (c *ClientWithResponses) VerifyContactWithResponse(ctx context.Context, verificationId int32, params *VerifyContactParams, reqEditors ...RequestEditorFn) (*VerifyContactResp, error)

VerifyContactWithResponse request returning *VerifyContactResp

func (*ClientWithResponses) ZoneCheckWithBodyWithResponse

func (c *ClientWithResponses) ZoneCheckWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ZoneCheckResp, error)

ZoneCheckWithBodyWithResponse request with arbitrary body returning *ZoneCheckResp

func (*ClientWithResponses) ZoneCheckWithResponse

func (c *ClientWithResponses) ZoneCheckWithResponse(ctx context.Context, body ZoneCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*ZoneCheckResp, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// CheckAccountBalanceWithResponse request
	CheckAccountBalanceWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*CheckAccountBalanceResp, error)

	// CreateAccountWithBodyWithResponse request with any body
	CreateAccountWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAccountResp, error)

	CreateAccountWithResponse(ctx context.Context, body CreateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAccountResp, error)

	// UnverifiedContactsListWithResponse request
	UnverifiedContactsListWithResponse(ctx context.Context, params *UnverifiedContactsListParams, reqEditors ...RequestEditorFn) (*UnverifiedContactsListResp, error)

	// VerifyContactWithResponse request
	VerifyContactWithResponse(ctx context.Context, verificationId int32, params *VerifyContactParams, reqEditors ...RequestEditorFn) (*VerifyContactResp, error)

	// GetRequirementWithResponse request
	GetRequirementWithResponse(ctx context.Context, tld string, reqEditors ...RequestEditorFn) (*GetRequirementResp, error)

	// ListDomainsWithResponse request
	ListDomainsWithResponse(ctx context.Context, params *ListDomainsParams, reqEditors ...RequestEditorFn) (*ListDomainsResp, error)

	// CreateDomainWithBodyWithResponse request with any body
	CreateDomainWithBodyWithResponse(ctx context.Context, params *CreateDomainParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDomainResp, error)

	CreateDomainWithResponse(ctx context.Context, params *CreateDomainParams, body CreateDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDomainResp, error)

	// GetDomainWithResponse request
	GetDomainWithResponse(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*GetDomainResp, error)

	// UpdateDomainWithBodyWithResponse request with any body
	UpdateDomainWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDomainResp, error)

	UpdateDomainWithResponse(ctx context.Context, domainName string, body UpdateDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDomainResp, error)

	// ListDNSSECsWithResponse request
	ListDNSSECsWithResponse(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*ListDNSSECsResp, error)

	// CreateDNSSECWithBodyWithResponse request with any body
	CreateDNSSECWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDNSSECResp, error)

	CreateDNSSECWithResponse(ctx context.Context, domainName string, body CreateDNSSECJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDNSSECResp, error)

	// DeleteDNSSECWithResponse request
	DeleteDNSSECWithResponse(ctx context.Context, domainName string, digest string, reqEditors ...RequestEditorFn) (*DeleteDNSSECResp, error)

	// GetDNSSECWithResponse request
	GetDNSSECWithResponse(ctx context.Context, domainName string, digest string, reqEditors ...RequestEditorFn) (*GetDNSSECResp, error)

	// ListEmailForwardingsWithResponse request
	ListEmailForwardingsWithResponse(ctx context.Context, domainName string, params *ListEmailForwardingsParams, reqEditors ...RequestEditorFn) (*ListEmailForwardingsResp, error)

	// CreateEmailForwardingWithBodyWithResponse request with any body
	CreateEmailForwardingWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEmailForwardingResp, error)

	CreateEmailForwardingWithResponse(ctx context.Context, domainName string, body CreateEmailForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEmailForwardingResp, error)

	// DeleteEmailForwardingWithResponse request
	DeleteEmailForwardingWithResponse(ctx context.Context, domainName string, emailBox string, reqEditors ...RequestEditorFn) (*DeleteEmailForwardingResp, error)

	// GetEmailForwardingWithResponse request
	GetEmailForwardingWithResponse(ctx context.Context, domainName string, emailBox string, reqEditors ...RequestEditorFn) (*GetEmailForwardingResp, error)

	// UpdateEmailForwardingWithBodyWithResponse request with any body
	UpdateEmailForwardingWithBodyWithResponse(ctx context.Context, domainName string, emailBox string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateEmailForwardingResp, error)

	UpdateEmailForwardingWithResponse(ctx context.Context, domainName string, emailBox string, body UpdateEmailForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateEmailForwardingResp, error)

	// ListRecordsWithResponse request
	ListRecordsWithResponse(ctx context.Context, domainName string, params *ListRecordsParams, reqEditors ...RequestEditorFn) (*ListRecordsResp, error)

	// CreateRecordWithBodyWithResponse request with any body
	CreateRecordWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRecordResp, error)

	CreateRecordWithResponse(ctx context.Context, domainName string, body CreateRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRecordResp, error)

	// DeleteRecordWithResponse request
	DeleteRecordWithResponse(ctx context.Context, domainName string, id int32, reqEditors ...RequestEditorFn) (*DeleteRecordResp, error)

	// GetRecordWithResponse request
	GetRecordWithResponse(ctx context.Context, domainName string, id int32, reqEditors ...RequestEditorFn) (*GetRecordResp, error)

	// UpdateRecordWithBodyWithResponse request with any body
	UpdateRecordWithBodyWithResponse(ctx context.Context, domainName string, id int32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRecordResp, error)

	UpdateRecordWithResponse(ctx context.Context, domainName string, id int32, body UpdateRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRecordResp, error)

	// ListURLForwardingsWithResponse request
	ListURLForwardingsWithResponse(ctx context.Context, domainName string, params *ListURLForwardingsParams, reqEditors ...RequestEditorFn) (*ListURLForwardingsResp, error)

	// CreateURLForwardingWithBodyWithResponse request with any body
	CreateURLForwardingWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateURLForwardingResp, error)

	CreateURLForwardingWithResponse(ctx context.Context, domainName string, body CreateURLForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateURLForwardingResp, error)

	// DeleteURLForwardingWithResponse request
	DeleteURLForwardingWithResponse(ctx context.Context, domainName string, host string, reqEditors ...RequestEditorFn) (*DeleteURLForwardingResp, error)

	// GetURLForwardingWithResponse request
	GetURLForwardingWithResponse(ctx context.Context, domainName string, host string, reqEditors ...RequestEditorFn) (*GetURLForwardingResp, error)

	// UpdateURLForwardingWithBodyWithResponse request with any body
	UpdateURLForwardingWithBodyWithResponse(ctx context.Context, domainName string, host string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateURLForwardingResp, error)

	UpdateURLForwardingWithResponse(ctx context.Context, domainName string, host string, body UpdateURLForwardingJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateURLForwardingResp, error)

	// ListVanityNameserversWithResponse request
	ListVanityNameserversWithResponse(ctx context.Context, domainName string, params *ListVanityNameserversParams, reqEditors ...RequestEditorFn) (*ListVanityNameserversResp, error)

	// CreateVanityNameserverWithBodyWithResponse request with any body
	CreateVanityNameserverWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVanityNameserverResp, error)

	CreateVanityNameserverWithResponse(ctx context.Context, domainName string, body CreateVanityNameserverJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVanityNameserverResp, error)

	// DeleteVanityNameserverWithResponse request
	DeleteVanityNameserverWithResponse(ctx context.Context, domainName string, hostname string, reqEditors ...RequestEditorFn) (*DeleteVanityNameserverResp, error)

	// GetVanityNameserverWithResponse request
	GetVanityNameserverWithResponse(ctx context.Context, domainName string, hostname string, reqEditors ...RequestEditorFn) (*GetVanityNameserverResp, error)

	// UpdateVanityNameserverWithBodyWithResponse request with any body
	UpdateVanityNameserverWithBodyWithResponse(ctx context.Context, domainName string, hostname string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateVanityNameserverResp, error)

	UpdateVanityNameserverWithResponse(ctx context.Context, domainName string, hostname string, body UpdateVanityNameserverJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateVanityNameserverResp, error)

	// DisableAutorenewWithResponse request
	DisableAutorenewWithResponse(ctx context.Context, domainName string, params *DisableAutorenewParams, reqEditors ...RequestEditorFn) (*DisableAutorenewResp, error)

	// DisableWhoisPrivacyWithResponse request
	DisableWhoisPrivacyWithResponse(ctx context.Context, domainName string, params *DisableWhoisPrivacyParams, reqEditors ...RequestEditorFn) (*DisableWhoisPrivacyResp, error)

	// EnableAutorenewWithResponse request
	EnableAutorenewWithResponse(ctx context.Context, domainName string, params *EnableAutorenewParams, reqEditors ...RequestEditorFn) (*EnableAutorenewResp, error)

	// EnableWhoisPrivacyWithResponse request
	EnableWhoisPrivacyWithResponse(ctx context.Context, domainName string, params *EnableWhoisPrivacyParams, reqEditors ...RequestEditorFn) (*EnableWhoisPrivacyResp, error)

	// GetAuthCodeForDomainWithResponse request
	GetAuthCodeForDomainWithResponse(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*GetAuthCodeForDomainResp, error)

	// GetPricingForDomainWithResponse request
	GetPricingForDomainWithResponse(ctx context.Context, domainName string, params *GetPricingForDomainParams, reqEditors ...RequestEditorFn) (*GetPricingForDomainResp, error)

	// LockDomainWithResponse request
	LockDomainWithResponse(ctx context.Context, domainName string, params *LockDomainParams, reqEditors ...RequestEditorFn) (*LockDomainResp, error)

	// PurchasePrivacyWithBodyWithResponse request with any body
	PurchasePrivacyWithBodyWithResponse(ctx context.Context, domainName string, params *PurchasePrivacyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PurchasePrivacyResp, error)

	PurchasePrivacyWithResponse(ctx context.Context, domainName string, params *PurchasePrivacyParams, body PurchasePrivacyJSONRequestBody, reqEditors ...RequestEditorFn) (*PurchasePrivacyResp, error)

	// RenewDomainWithBodyWithResponse request with any body
	RenewDomainWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RenewDomainResp, error)

	RenewDomainWithResponse(ctx context.Context, domainName string, body RenewDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*RenewDomainResp, error)

	// SetContactsWithBodyWithResponse request with any body
	SetContactsWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetContactsResp, error)

	SetContactsWithResponse(ctx context.Context, domainName string, body SetContactsJSONRequestBody, reqEditors ...RequestEditorFn) (*SetContactsResp, error)

	// SetNameserversWithBodyWithResponse request with any body
	SetNameserversWithBodyWithResponse(ctx context.Context, domainName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetNameserversResp, error)

	SetNameserversWithResponse(ctx context.Context, domainName string, body SetNameserversJSONRequestBody, reqEditors ...RequestEditorFn) (*SetNameserversResp, error)

	// UnlockDomainWithResponse request
	UnlockDomainWithResponse(ctx context.Context, domainName string, params *UnlockDomainParams, reqEditors ...RequestEditorFn) (*UnlockDomainResp, error)

	// CheckAvailabilityWithBodyWithResponse request with any body
	CheckAvailabilityWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CheckAvailabilityResp, error)

	CheckAvailabilityWithResponse(ctx context.Context, body CheckAvailabilityJSONRequestBody, reqEditors ...RequestEditorFn) (*CheckAvailabilityResp, error)

	// SearchWithBodyWithResponse request with any body
	SearchWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchResp, error)

	SearchWithResponse(ctx context.Context, body SearchJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchResp, error)

	// HelloWithResponse request
	HelloWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HelloResp, error)

	// GetSubscribedNotificationsWithResponse request
	GetSubscribedNotificationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSubscribedNotificationsResp, error)

	// SubscribeToNotificationWithBodyWithResponse request with any body
	SubscribeToNotificationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubscribeToNotificationResp, error)

	SubscribeToNotificationWithResponse(ctx context.Context, body SubscribeToNotificationJSONRequestBody, reqEditors ...RequestEditorFn) (*SubscribeToNotificationResp, error)

	// DeleteSubscriptionWithResponse request
	DeleteSubscriptionWithResponse(ctx context.Context, id int32, reqEditors ...RequestEditorFn) (*DeleteSubscriptionResp, error)

	// ModifySubscriptionWithBodyWithResponse request with any body
	ModifySubscriptionWithBodyWithResponse(ctx context.Context, id int32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ModifySubscriptionResp, error)

	ModifySubscriptionWithResponse(ctx context.Context, id int32, body ModifySubscriptionJSONRequestBody, reqEditors ...RequestEditorFn) (*ModifySubscriptionResp, error)

	// ListOrdersWithResponse request
	ListOrdersWithResponse(ctx context.Context, params *ListOrdersParams, reqEditors ...RequestEditorFn) (*ListOrdersResp, error)

	// GetOrderWithResponse request
	GetOrderWithResponse(ctx context.Context, orderId int32, reqEditors ...RequestEditorFn) (*GetOrderResp, error)

	// PremiumDomainListsWithResponse request
	PremiumDomainListsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PremiumDomainListsResp, error)

	// TldPriceListWithResponse request
	TldPriceListWithResponse(ctx context.Context, params *TldPriceListParams, reqEditors ...RequestEditorFn) (*TldPriceListResp, error)

	// ListTransfersWithResponse request
	ListTransfersWithResponse(ctx context.Context, params *ListTransfersParams, reqEditors ...RequestEditorFn) (*ListTransfersResp, error)

	// CreateTransferWithBodyWithResponse request with any body
	CreateTransferWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTransferResp, error)

	CreateTransferWithResponse(ctx context.Context, body CreateTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTransferResp, error)

	// GetTransferWithResponse request
	GetTransferWithResponse(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*GetTransferResp, error)

	// CancelTransferWithResponse request
	CancelTransferWithResponse(ctx context.Context, domainName string, reqEditors ...RequestEditorFn) (*CancelTransferResp, error)

	// ZoneCheckWithBodyWithResponse request with any body
	ZoneCheckWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ZoneCheckResp, error)

	ZoneCheckWithResponse(ctx context.Context, body ZoneCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*ZoneCheckResp, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type Conflict409

type Conflict409 struct {
	// Details Additional context or information about the pricing error
	Details *string `json:"details,omitempty"`

	// Message A human-readable message providing more details about the error
	Message string `json:"message"`
}

Conflict409 defines model for Conflict409.

type Contact

type Contact struct {
	// Address1 The first line of the contact's address.
	Address1 string `json:"address1"`

	// Address2 The second line of the contact's address (optional).
	Address2 *string `json:"address2"`

	// City City of the contact's address.
	City string `json:"city"`

	// CompanyName Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.
	CompanyName *string `json:"companyName"`

	// Country Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
	Country string `json:"country"`

	// Email Email address of the contact. Must be a valid email format. The validation is performed against the `addr-spec` syntax in [RFC 822](https://datatracker.ietf.org/doc/html/rfc822)
	Email openapi_types.Email `json:"email"`

	// Fax Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
	Fax *string `json:"fax"`

	// FirstName First name of the contact.
	FirstName string `json:"firstName"`

	// IsVerified Indicates if the contact has been verified as per ICANN requirements. If the value is `false` it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.
	IsVerified *bool `json:"isVerified,omitempty"`

	// LastName Last name of the contact.
	LastName string `json:"lastName"`

	// Phone Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
	Phone string `json:"phone"`

	// State State or Province of the contact's address.
	State string `json:"state"`

	// Zip ZIP or Postal Code of the contact's address.
	Zip string `json:"zip"`
}

Contact Contact contains all relevant contact data for a domain registrant.

type Contacts

type Contacts struct {
	// Admin Contact contains all relevant contact data for a domain registrant.
	Admin *Contact `json:"admin,omitempty"`

	// Billing Contact contains all relevant contact data for a domain registrant.
	Billing *Contact `json:"billing,omitempty"`

	// Registrant Contact contains all relevant contact data for a domain registrant.
	Registrant *RegistrantContact `json:"registrant,omitempty"`

	// Tech Contact contains all relevant contact data for a domain registrant.
	Tech *Contact `json:"tech,omitempty"`
}

Contacts Contacts stores the contact information for the roles related to domains.

type CreateAccountJSONRequestBody

type CreateAccountJSONRequestBody = CreateAccountRequest

CreateAccountJSONRequestBody defines body for CreateAccount for application/json ContentType.

type CreateAccountRequest

type CreateAccountRequest struct {
	// Account Account lists all the data for an account.
	Account Account `json:"account"`

	// ApiTos Must be set to true to indicate acceptance of the API Terms of Service.
	ApiTos bool `json:"apiTos"`

	// Tos Must be set to true to indicate acceptance of the general Terms of Service.
	Tos bool `json:"tos"`
}

CreateAccountRequest CreateAccountRequest has the information that is needed to create an account with the CreateAccount function.

type CreateAccountResp

type CreateAccountResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CreateAccountResponse
	JSON400      *InvalidArgument400
	JSON401      *Unauthorized401
	JSON403      *GenericForbidden403
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
}

func ParseCreateAccountResp

func ParseCreateAccountResp(rsp *http.Response) (*CreateAccountResp, error)

ParseCreateAccountResp parses an HTTP response from a CreateAccountWithResponse call

func (CreateAccountResp) Status

func (r CreateAccountResp) Status() string

Status returns HTTPResponse.Status

func (CreateAccountResp) StatusCode

func (r CreateAccountResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateAccountResponse

type CreateAccountResponse struct {
	// AccountName AccountName is the unique user-assigned name of newly created account.
	AccountName string `json:"accountName"`

	// ApiToken The authentication token that should be used to access the API. This value is only returned once upon account creation.
	ApiToken string `json:"apiToken"`

	// ApiTokenName ApiTokenName user assigned name of api token.
	ApiTokenName string `json:"apiTokenName"`
}

CreateAccountResponse CreateAccountResponse contains information about the newly created account and the API credentials generated for it.

type CreateDNSSECBody

type CreateDNSSECBody struct {
	Algorithm *int32 `json:"algorithm,omitempty"`

	// Digest Digest is a digest of the DNSKEY RR that is registered with the registry.
	Digest     *string `json:"digest,omitempty"`
	DigestType *int32  `json:"digestType,omitempty"`

	// DomainName The name of the domain.
	DomainName *string `json:"domainName,omitempty"`
	KeyTag     *int32  `json:"keyTag,omitempty"`
}

CreateDNSSECBody DNSSEC contains all the data required to create a DS record at the registry.

type CreateDNSSECJSONRequestBody

type CreateDNSSECJSONRequestBody = CreateDNSSECBody

CreateDNSSECJSONRequestBody defines body for CreateDNSSEC for application/json ContentType.

type CreateDNSSECResp

type CreateDNSSECResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DNSSEC
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseCreateDNSSECResp

func ParseCreateDNSSECResp(rsp *http.Response) (*CreateDNSSECResp, error)

ParseCreateDNSSECResp parses an HTTP response from a CreateDNSSECWithResponse call

func (CreateDNSSECResp) Status

func (r CreateDNSSECResp) Status() string

Status returns HTTPResponse.Status

func (CreateDNSSECResp) StatusCode

func (r CreateDNSSECResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDate

type CreateDate = time.Time

CreateDate The date and time when the domain was created at the registry.

type CreateDomainJSONRequestBody

type CreateDomainJSONRequestBody = CreateDomainRequest

CreateDomainJSONRequestBody defines body for CreateDomain for application/json ContentType.

type CreateDomainParams

type CreateDomainParams struct {
	// XIdempotencyKey A unique string (e.g., a UUID v4) to make the request idempotent. This key ensures that if the request is retried, the operation will not be performed multiple times. Subsequent requests with the same key will return the original result.
	XIdempotencyKey *string `json:"X-Idempotency-Key,omitempty"`
}

CreateDomainParams defines parameters for CreateDomain.

type CreateDomainRequest

type CreateDomainRequest struct {
	// Domain The payload to be sent for when making a request to purchase a domain.
	Domain DomainCreatePayload `json:"domain"`

	// PurchasePrice PurchasePrice is the price in USD for purchasing this domain for the minimum time period (typically 1 year). PurchasePrice is required if purchaseType is not "registration" or if it is a premium domain. If privacyEnabled is set, the regular price for Whois Privacy protection will be added automatically. If VAT tax applies, it will also be added automatically.
	PurchasePrice *float64 `json:"purchasePrice,omitempty"`

	// PurchaseType PurchaseType defaults to "registration" but should be copied from the result of either a [Search](#operation/Search) or [checkAvailability](#operation/CheckAvailability) request.
	PurchaseType *string `json:"purchaseType,omitempty"`

	// TldRequirements TLDRequirements is a way to pass additional data that is required by some registries. You can check before registration by using the [Domain Info](#operation/GetRequirement) API.
	// As these requirements vary wildly between registries and TLDs, we are not attempting to document them here.
	// #### IDN Domains
	// This parameter is required for registering domains that contain non-ASCII characters.  The value should be the specific code for the character set, such as `ES` for Spanish, or `CYRL` for Cyrillic. These abbreviations can vary between TLDs, and it is highly recommended that you use [Domain Info](#operation/GetRequirement) API to ensure that the TLD allows for the specific IDN table, as well as the correct abbreviation.
	TldRequirements *map[string]string `json:"tldRequirements,omitempty"`

	// Years Years specifies how many years to register the domain for. Years defaults to the minimum time period (typically 1 year) if not passed and cannot be more than 10. Some TLDs default to longer initial periods (e.g. .AI requires a 2 year registration).
	// If passing purchasePrice make sure to adjust it accordingly.
	Years *int32 `json:"years,omitempty"`
}

CreateDomainRequest CreateDomainRequest has the information that is needed to create a domain with the CreateDomain function.

type CreateDomainResp

type CreateDomainResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CreateDomainResponse
	JSON400      *InvalidArgument400
	JSON401      *Unauthorized401
	JSON402      *PaymentRequired402
	JSON404      *NotFound404
	JSON409      *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON415 *UnsupportedMedia415
	JSON422 *UnprocessableEntity422
	JSON429 *TooManyRequests429
	JSON451 *UnavailableForLegal451
	JSON500 *GenericError500
	JSON501 *GenericError501
}

func ParseCreateDomainResp

func ParseCreateDomainResp(rsp *http.Response) (*CreateDomainResp, error)

ParseCreateDomainResp parses an HTTP response from a CreateDomainWithResponse call

func (CreateDomainResp) Status

func (r CreateDomainResp) Status() string

Status returns HTTPResponse.Status

func (CreateDomainResp) StatusCode

func (r CreateDomainResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDomainResponse

type CreateDomainResponse struct {
	// Domain The response format for a domain.
	Domain DomainResponsePayload `json:"domain"`

	// Order Order is an identifier for this purchase.
	Order int32 `json:"order"`

	// TotalPaid TotalPaid is the total amount paid, including VAT and Whois privacy protection.
	TotalPaid float64 `json:"totalPaid"`
}

CreateDomainResponse CreateDomainResponse contains the domain info as well as the order info for the created domain.

type CreateEmailForwardingJSONRequestBody

type CreateEmailForwardingJSONRequestBody = CreateEmailForwardingRequest

CreateEmailForwardingJSONRequestBody defines body for CreateEmailForwarding for application/json ContentType.

type CreateEmailForwardingRequest

type CreateEmailForwardingRequest struct {
	// EmailBox EmailBox is the user portion of the email address to forward. If your email is "admin@example.com", it would just be "admin"
	EmailBox string `json:"emailBox"`

	// EmailTo EmailTo is the entire email address to forward email to.
	EmailTo openapi_types.Email `json:"emailTo"`
}

CreateEmailForwardingRequest EmailForwarding contains all the information for an email forwarding entry.

type CreateEmailForwardingResp

type CreateEmailForwardingResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *EmailForwarding
	JSON400      *InvalidArgument400
	JSON403      *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON415 *UnsupportedMedia415
	JSON429 *TooManyRequests429
	JSON500 *GenericError500
}

func ParseCreateEmailForwardingResp

func ParseCreateEmailForwardingResp(rsp *http.Response) (*CreateEmailForwardingResp, error)

ParseCreateEmailForwardingResp parses an HTTP response from a CreateEmailForwardingWithResponse call

func (CreateEmailForwardingResp) Status

func (r CreateEmailForwardingResp) Status() string

Status returns HTTPResponse.Status

func (CreateEmailForwardingResp) StatusCode

func (r CreateEmailForwardingResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateRecordJSONRequestBody

type CreateRecordJSONRequestBody = DNSCreateRecordBody

CreateRecordJSONRequestBody defines body for CreateRecord for application/json ContentType.

type CreateRecordResp

type CreateRecordResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Record
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseCreateRecordResp

func ParseCreateRecordResp(rsp *http.Response) (*CreateRecordResp, error)

ParseCreateRecordResp parses an HTTP response from a CreateRecordWithResponse call

func (CreateRecordResp) Status

func (r CreateRecordResp) Status() string

Status returns HTTPResponse.Status

func (CreateRecordResp) StatusCode

func (r CreateRecordResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateTransferJSONRequestBody

type CreateTransferJSONRequestBody = CreateTransferRequest

CreateTransferJSONRequestBody defines body for CreateTransfer for application/json ContentType.

type CreateTransferRequest

type CreateTransferRequest struct {
	// AuthCode AuthCode is the authorization code for the transfer. Not all TLDs require authorization codes, but most do.
	AuthCode string `json:"authCode"`

	// DomainName DomainName is the domain you want to transfer to name.com.
	DomainName string `json:"domainName"`

	// PrivacyEnabled PrivacyEnabled is a flag on whether to purchase Whois Privacy with the transfer.
	PrivacyEnabled *bool `json:"privacyEnabled,omitempty"`

	// PurchasePrice PurchasePrice is the amount to pay for the transfer of the domain. If privacy_enabled is set, the regular price for Whois Privacy will be added automatically. If VAT tax applies, it will also be added automatically.
	// PurchasePrice is required if the domain to transfer is a premium domain.
	PurchasePrice *float64 `json:"purchasePrice,omitempty"`
}

CreateTransferRequest CreateTransferRequest passes the required transfer info to the CreateTransfer function.

type CreateTransferResp

type CreateTransferResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CreateTransferResponse
	JSON400      *InvalidArgument400
	JSON402      *GenericError500
	JSON409      *GenericConflict409
	JSON415      *UnsupportedMedia415
	JSON422      *UnprocessableEntity422
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseCreateTransferResp

func ParseCreateTransferResp(rsp *http.Response) (*CreateTransferResp, error)

ParseCreateTransferResp parses an HTTP response from a CreateTransferWithResponse call

func (CreateTransferResp) Status

func (r CreateTransferResp) Status() string

Status returns HTTPResponse.Status

func (CreateTransferResp) StatusCode

func (r CreateTransferResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateTransferResponse

type CreateTransferResponse struct {
	// Order Order is an identifier for this purchase.
	Order int32 `json:"order"`

	// TotalPaid TotalPaid is the total amount paid, including VAT and Whois Privacy.
	TotalPaid float64 `json:"totalPaid"`

	// Transfer Transfer contains all relevant data for a domain transfer to name.com.
	Transfer Transfer `json:"transfer"`
}

CreateTransferResponse CreateTransferResponse returns the newly created transfer resource as well as the order information.

type CreateURLForwardingBody

type CreateURLForwardingBody = URLForwarding

CreateURLForwardingBody URLForwarding represents a URL forwarding entry, allowing a domain to redirect to another URL using different forwarding methods.

type CreateURLForwardingJSONRequestBody

type CreateURLForwardingJSONRequestBody = CreateURLForwardingBody

CreateURLForwardingJSONRequestBody defines body for CreateURLForwarding for application/json ContentType.

type CreateURLForwardingResp

type CreateURLForwardingResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *URLForwardingResponse
	JSON400      *InvalidArgument400
	JSON401      *Unauthorized401
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON409      *GenericConflict409
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseCreateURLForwardingResp

func ParseCreateURLForwardingResp(rsp *http.Response) (*CreateURLForwardingResp, error)

ParseCreateURLForwardingResp parses an HTTP response from a CreateURLForwardingWithResponse call

func (CreateURLForwardingResp) Status

func (r CreateURLForwardingResp) Status() string

Status returns HTTPResponse.Status

func (CreateURLForwardingResp) StatusCode

func (r CreateURLForwardingResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateVanityNameserverBody

type CreateVanityNameserverBody struct {
	// Hostname The subdomain portion of the nameserver hostname. The domain portion will be  taken from the URL path. For example, to create 'ns1.example.com', specify 'ns1'  when calling the endpoint for the domain 'example.com'.
	Hostname string `json:"hostname"`

	// Ips IPs is a list of IP addresses that are used for glue records for this nameserver. These should be valid IPv4 or IPv6 addresses.
	Ips []string `json:"ips"`
}

CreateVanityNameserverBody VanityNameserver contains the hostname as well as the list of IP addresses for nameservers.

type CreateVanityNameserverJSONRequestBody

type CreateVanityNameserverJSONRequestBody = CreateVanityNameserverBody

CreateVanityNameserverJSONRequestBody defines body for CreateVanityNameserver for application/json ContentType.

type CreateVanityNameserverResp

type CreateVanityNameserverResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *VanityNameserverResponse
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseCreateVanityNameserverResp

func ParseCreateVanityNameserverResp(rsp *http.Response) (*CreateVanityNameserverResp, error)

ParseCreateVanityNameserverResp parses an HTTP response from a CreateVanityNameserverWithResponse call

func (CreateVanityNameserverResp) Status

Status returns HTTPResponse.Status

func (CreateVanityNameserverResp) StatusCode

func (r CreateVanityNameserverResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DNSCreateRecordBody

type DNSCreateRecordBody struct {
	// Answer Answer is either the IP address for A or AAAA records; the target for ANAME, CNAME, MX, or NS records; the text for TXT records.
	// For SRV records, answer has the following format: "{weight} {port} {target}" e.g. "1 5061 sip.example.org".
	Answer string `json:"answer"`

	// Fqdn FQDN is the Fully Qualified Domain Name. It is the combination of the host and the domain name. It always ends in a ".". FQDN is ignored in CreateRecord, specify via the Host field instead.
	Fqdn *string `json:"fqdn,omitempty"`

	// Host Host is the hostname relative to the zone: e.g. for a record for blog.example.org, domain would be "example.org" and host would be "blog".
	// An apex record would be specified by either an empty host "" or "@".
	// A SRV record would be specified by "_{service}._{protocol}.{host}": e.g. "_sip._tcp.phone" for _sip._tcp.phone.example.org.
	Host string `json:"host"`

	// Id Unique record id. Value is ignored on Create, and must match the URI on Update.
	Id *int32 `json:"id,omitempty"`

	// Priority Priority is only required for MX and SRV records, it is ignored for all others.
	Priority *int64 `json:"priority,omitempty"`

	// Ttl TTL is the time this record can be cached for in seconds. name.com allows a minimum TTL of 300, or 5 minutes.
	Ttl *int64 `json:"ttl,omitempty"`

	// Type Type is one of the following: A, AAAA, ANAME, CNAME, MX, NS, SRV, or TXT.
	Type DNSCreateRecordBodyType `json:"type"`
}

DNSCreateRecordBody Record is an individual DNS resource record.

type DNSCreateRecordBodyType

type DNSCreateRecordBodyType string

DNSCreateRecordBodyType Type is one of the following: A, AAAA, ANAME, CNAME, MX, NS, SRV, or TXT.

const (
	DNSCreateRecordBodyTypeA     DNSCreateRecordBodyType = "A"
	DNSCreateRecordBodyTypeAAAA  DNSCreateRecordBodyType = "AAAA"
	DNSCreateRecordBodyTypeANAME DNSCreateRecordBodyType = "ANAME"
	DNSCreateRecordBodyTypeCNAME DNSCreateRecordBodyType = "CNAME"
	DNSCreateRecordBodyTypeMX    DNSCreateRecordBodyType = "MX"
	DNSCreateRecordBodyTypeNS    DNSCreateRecordBodyType = "NS"
	DNSCreateRecordBodyTypeSRV   DNSCreateRecordBodyType = "SRV"
	DNSCreateRecordBodyTypeTXT   DNSCreateRecordBodyType = "TXT"
)

Defines values for DNSCreateRecordBodyType.

type DNSSEC

type DNSSEC struct {
	Algorithm int32 `json:"algorithm"`

	// Digest Digest is a digest of the DNSKEY RR that is registered with the registry.
	Digest     string `json:"digest"`
	DigestType int32  `json:"digestType"`

	// DomainName DomainName is the domain name.
	DomainName string `json:"domainName"`
	KeyTag     int32  `json:"keyTag"`
}

DNSSEC DNSSEC contains all the data required to create a DS record at the registry.

type DNSUpdateRecordBody

type DNSUpdateRecordBody struct {
	// Answer Answer is either the IP address for A or AAAA records; the target for ANAME, CNAME, MX, or NS records; the text for TXT records.
	// For SRV records, answer has the following format: "{weight} {port} {target}" e.g. "1 5061 sip.example.org".
	Answer string `json:"answer"`

	// Fqdn FQDN is the Fully Qualified Domain Name. It is the combination of the host and the domain name. It always ends in a ".". FQDN is ignored in CreateRecord, specify via the Host field instead.
	Fqdn *string `json:"fqdn,omitempty"`

	// Host Host is the hostname relative to the zone: e.g. for a record for blog.example.org, domain would be "example.org" and host would be "blog".
	// An apex record would be specified by either an empty host "" or "@".
	// A SRV record would be specified by "_{service}._{protocol}.{host}": e.g. "_sip._tcp.phone" for _sip._tcp.phone.example.org.
	Host *string `json:"host,omitempty"`

	// Priority Priority is only required for MX and SRV records, it is ignored for all others.
	Priority *int64 `json:"priority,omitempty"`

	// Ttl TTL is the time this record can be cached for in seconds. name.com allows a minimum TTL of 300, or 5 minutes.
	Ttl *int64 `json:"ttl,omitempty"`

	// Type Type is one of the following: A, AAAA, ANAME, CNAME, MX, NS, SRV, or TXT.
	Type DNSUpdateRecordBodyType `json:"type"`
}

DNSUpdateRecordBody Record is an individual DNS resource record.

type DNSUpdateRecordBodyType

type DNSUpdateRecordBodyType string

DNSUpdateRecordBodyType Type is one of the following: A, AAAA, ANAME, CNAME, MX, NS, SRV, or TXT.

const (
	DNSUpdateRecordBodyTypeA     DNSUpdateRecordBodyType = "A"
	DNSUpdateRecordBodyTypeAAAA  DNSUpdateRecordBodyType = "AAAA"
	DNSUpdateRecordBodyTypeANAME DNSUpdateRecordBodyType = "ANAME"
	DNSUpdateRecordBodyTypeCNAME DNSUpdateRecordBodyType = "CNAME"
	DNSUpdateRecordBodyTypeMX    DNSUpdateRecordBodyType = "MX"
	DNSUpdateRecordBodyTypeNS    DNSUpdateRecordBodyType = "NS"
	DNSUpdateRecordBodyTypeSRV   DNSUpdateRecordBodyType = "SRV"
	DNSUpdateRecordBodyTypeTXT   DNSUpdateRecordBodyType = "TXT"
)

Defines values for DNSUpdateRecordBodyType.

type DeleteDNSSECResp

type DeleteDNSSECResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseDeleteDNSSECResp

func ParseDeleteDNSSECResp(rsp *http.Response) (*DeleteDNSSECResp, error)

ParseDeleteDNSSECResp parses an HTTP response from a DeleteDNSSECWithResponse call

func (DeleteDNSSECResp) Status

func (r DeleteDNSSECResp) Status() string

Status returns HTTPResponse.Status

func (DeleteDNSSECResp) StatusCode

func (r DeleteDNSSECResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteEmailForwardingResp

type DeleteEmailForwardingResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON403      *GenericForbidden403
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseDeleteEmailForwardingResp

func ParseDeleteEmailForwardingResp(rsp *http.Response) (*DeleteEmailForwardingResp, error)

ParseDeleteEmailForwardingResp parses an HTTP response from a DeleteEmailForwardingWithResponse call

func (DeleteEmailForwardingResp) Status

func (r DeleteEmailForwardingResp) Status() string

Status returns HTTPResponse.Status

func (DeleteEmailForwardingResp) StatusCode

func (r DeleteEmailForwardingResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteRecordResp

type DeleteRecordResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseDeleteRecordResp

func ParseDeleteRecordResp(rsp *http.Response) (*DeleteRecordResp, error)

ParseDeleteRecordResp parses an HTTP response from a DeleteRecordWithResponse call

func (DeleteRecordResp) Status

func (r DeleteRecordResp) Status() string

Status returns HTTPResponse.Status

func (DeleteRecordResp) StatusCode

func (r DeleteRecordResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteSubscriptionResp

type DeleteSubscriptionResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON401      *Unauthorized401
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseDeleteSubscriptionResp

func ParseDeleteSubscriptionResp(rsp *http.Response) (*DeleteSubscriptionResp, error)

ParseDeleteSubscriptionResp parses an HTTP response from a DeleteSubscriptionWithResponse call

func (DeleteSubscriptionResp) Status

func (r DeleteSubscriptionResp) Status() string

Status returns HTTPResponse.Status

func (DeleteSubscriptionResp) StatusCode

func (r DeleteSubscriptionResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteURLForwardingResp

type DeleteURLForwardingResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON401      *Unauthorized401
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseDeleteURLForwardingResp

func ParseDeleteURLForwardingResp(rsp *http.Response) (*DeleteURLForwardingResp, error)

ParseDeleteURLForwardingResp parses an HTTP response from a DeleteURLForwardingWithResponse call

func (DeleteURLForwardingResp) Status

func (r DeleteURLForwardingResp) Status() string

Status returns HTTPResponse.Status

func (DeleteURLForwardingResp) StatusCode

func (r DeleteURLForwardingResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteVanityNameserverResp

type DeleteVanityNameserverResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseDeleteVanityNameserverResp

func ParseDeleteVanityNameserverResp(rsp *http.Response) (*DeleteVanityNameserverResp, error)

ParseDeleteVanityNameserverResp parses an HTTP response from a DeleteVanityNameserverWithResponse call

func (DeleteVanityNameserverResp) Status

Status returns HTTPResponse.Status

func (DeleteVanityNameserverResp) StatusCode

func (r DeleteVanityNameserverResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DisableAutorenewParams

type DisableAutorenewParams struct {
	// ContentType Required Content-Type Header for POST requests.
	ContentType DisableAutorenewParamsContentType `json:"Content-Type"`
}

DisableAutorenewParams defines parameters for DisableAutorenew.

type DisableAutorenewParamsContentType

type DisableAutorenewParamsContentType string

DisableAutorenewParamsContentType defines parameters for DisableAutorenew.

const (
	DisableAutorenewParamsContentTypeApplicationjson DisableAutorenewParamsContentType = "application/json"
)

Defines values for DisableAutorenewParamsContentType.

type DisableAutorenewResp

type DisableAutorenewResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Domain
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseDisableAutorenewResp

func ParseDisableAutorenewResp(rsp *http.Response) (*DisableAutorenewResp, error)

ParseDisableAutorenewResp parses an HTTP response from a DisableAutorenewWithResponse call

func (DisableAutorenewResp) Status

func (r DisableAutorenewResp) Status() string

Status returns HTTPResponse.Status

func (DisableAutorenewResp) StatusCode

func (r DisableAutorenewResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DisableWhoisPrivacyParams

type DisableWhoisPrivacyParams struct {
	// ContentType Required Content-Type Header for POST requests.
	ContentType DisableWhoisPrivacyParamsContentType `json:"Content-Type"`
}

DisableWhoisPrivacyParams defines parameters for DisableWhoisPrivacy.

type DisableWhoisPrivacyParamsContentType

type DisableWhoisPrivacyParamsContentType string

DisableWhoisPrivacyParamsContentType defines parameters for DisableWhoisPrivacy.

const (
	DisableWhoisPrivacyParamsContentTypeApplicationjson DisableWhoisPrivacyParamsContentType = "application/json"
)

Defines values for DisableWhoisPrivacyParamsContentType.

type DisableWhoisPrivacyResp

type DisableWhoisPrivacyResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Domain
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseDisableWhoisPrivacyResp

func ParseDisableWhoisPrivacyResp(rsp *http.Response) (*DisableWhoisPrivacyResp, error)

ParseDisableWhoisPrivacyResp parses an HTTP response from a DisableWhoisPrivacyWithResponse call

func (DisableWhoisPrivacyResp) Status

func (r DisableWhoisPrivacyResp) Status() string

Status returns HTTPResponse.Status

func (DisableWhoisPrivacyResp) StatusCode

func (r DisableWhoisPrivacyResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Domain

type Domain struct {
	// AutorenewEnabled Indicates whether the domain is set to renew automatically before expiration.
	AutorenewEnabled *bool `json:"autorenewEnabled,omitempty"`

	// Contacts Contacts stores the contact information for the roles related to domains.
	Contacts *Contacts `json:"contacts,omitempty"`

	// CreateDate The date and time when the domain was created at the registry.
	CreateDate *time.Time `json:"createDate,omitempty"`

	// DomainName The punycode-encoded value of the domain name.
	DomainName *string `json:"domainName,omitempty"`

	// ExpireDate The date and time when the domain will expire.
	ExpireDate *time.Time `json:"expireDate,omitempty"`

	// Locked Indicates if the domain is locked, preventing transfers to another registrar.
	Locked *bool `json:"locked,omitempty"`

	// Nameservers The list of nameservers assigned to this domain. If unspecified, it defaults to the account's default nameservers.
	Nameservers *[]string `json:"nameservers,omitempty"`

	// PrivacyEnabled Indicates if Whois Privacy is enabled for this domain.
	PrivacyEnabled *bool `json:"privacyEnabled,omitempty"`

	// RenewalPrice The cost to renew the domain. This may be required for the RenewDomain operation.
	RenewalPrice *float64 `json:"renewalPrice,omitempty"`
}

Domain Domain contains all relevant data for a domain.

type DomainCreatePayload

type DomainCreatePayload struct {
	// AutorenewEnabled Indicates whether the domain is set to renew automatically before expiration.
	AutorenewEnabled *bool `json:"autorenewEnabled,omitempty"`

	// Contacts Contacts stores the contact information for the roles related to domains.
	Contacts *Contacts `json:"contacts,omitempty"`

	// CreateDate The date and time when the domain was created at the registry.
	CreateDate *time.Time `json:"createDate,omitempty"`
	DomainName string     `json:"domainName"`

	// ExpireDate The date and time when the domain will expire.
	ExpireDate *time.Time `json:"expireDate,omitempty"`

	// Locked Indicates if the domain is locked, preventing transfers to another registrar.
	Locked *bool `json:"locked,omitempty"`

	// Nameservers The list of nameservers assigned to this domain. If unspecified, it defaults to the account's default nameservers.
	Nameservers *[]string `json:"nameservers,omitempty"`

	// PrivacyEnabled Indicates if Whois Privacy is enabled for this domain.
	PrivacyEnabled *bool `json:"privacyEnabled,omitempty"`

	// RenewalPrice The cost to renew the domain. This may be required for the RenewDomain operation.
	RenewalPrice *float64 `json:"renewalPrice,omitempty"`
}

DomainCreatePayload defines model for DomainCreatePayload.

type DomainLockStatusChange

type DomainLockStatusChange struct {
	Action DomainLockStatusChangeAction `json:"action"`

	// DomainName Fully-qualified domain name
	DomainName string                          `json:"domainName"`
	EventName  DomainLockStatusChangeEventName `json:"eventName"`

	// LockType The lock type affected by this event (added or removed)
	LockType DomainLockStatusChangeLockType `json:"lockType"`

	// RegistryStatuses Current registry statuses after the change
	RegistryStatuses []string `json:"registryStatuses"`
}

DomainLockStatusChange defines model for DomainLockStatusChange.

type DomainLockStatusChangeAction

type DomainLockStatusChangeAction string

DomainLockStatusChangeAction defines model for DomainLockStatusChange.Action.

const (
	Added   DomainLockStatusChangeAction = "added"
	Removed DomainLockStatusChangeAction = "removed"
)

Defines values for DomainLockStatusChangeAction.

type DomainLockStatusChangeEventName

type DomainLockStatusChangeEventName string

DomainLockStatusChangeEventName defines model for DomainLockStatusChange.EventName.

const (
	DomainLockStatusChangeEventNameDomainLockStatusChange DomainLockStatusChangeEventName = "domain.lock.status_change"
)

Defines values for DomainLockStatusChangeEventName.

type DomainLockStatusChangeLockType

type DomainLockStatusChangeLockType string

DomainLockStatusChangeLockType The lock type affected by this event (added or removed)

const (
	AccountLock            DomainLockStatusChangeLockType = "AccountLock"
	ClientHold             DomainLockStatusChangeLockType = "ClientHold"
	PrivacyLock            DomainLockStatusChangeLockType = "PrivacyLock"
	RegistrarLock          DomainLockStatusChangeLockType = "RegistrarLock"
	TransferLock           DomainLockStatusChangeLockType = "TransferLock"
	VerificationClientHold DomainLockStatusChangeLockType = "VerificationClientHold"
	VerificationHold       DomainLockStatusChangeLockType = "VerificationHold"
)

Defines values for DomainLockStatusChangeLockType.

type DomainName

type DomainName = string

DomainName The punycode-encoded value of the domain name.

type DomainResponsePayload

type DomainResponsePayload struct {
	// AutorenewEnabled Indicates whether the domain is set to renew automatically before expiration.
	AutorenewEnabled AutorenewEnabled `json:"autorenewEnabled"`

	// Contacts Contacts stores the contact information for the roles related to domains.
	Contacts Contacts `json:"contacts"`

	// CreateDate The date and time when the domain was created at the registry.
	CreateDate *CreateDate `json:"createDate,omitempty"`

	// DomainName The punycode-encoded value of the domain name.
	DomainName DomainName `json:"domainName"`

	// ExpireDate The date and time when the domain will expire.
	ExpireDate *ExpireDate `json:"expireDate,omitempty"`

	// Locked Indicates if the domain is locked, preventing transfers to another registrar.
	Locked Locked `json:"locked"`

	// Nameservers The list of nameservers assigned to this domain. If unspecified, it defaults to the account's default nameservers.
	Nameservers Nameservers `json:"nameservers"`

	// PrivacyEnabled Indicates if Whois Privacy is enabled for this domain.
	PrivacyEnabled PrivacyEnabled `json:"privacyEnabled"`

	// RenewalPrice The cost to renew the domain. This may be required for the RenewDomain operation.
	RenewalPrice *RenewalPrice `json:"renewalPrice,omitempty"`
}

DomainResponsePayload defines model for DomainResponsePayload.

type DomainTransferStatusChange

type DomainTransferStatusChange struct {
	// DomainName The domain that the transfer status has changed for
	DomainName string `json:"domainName"`

	// EventName The name of the subscription event
	EventName string `json:"eventName"`

	// Status The updated status of the domain transfer. The transfer status will be one of the following values:
	// - **canceled:** The transfer has been canceled by the user.
	// - **canceled_pending_refund**: The transfer has been canceled by the user, and a refund for the price is being processed.
	// - **completed**: The transfer has completed.
	// - **failed**: The transfer has failed, and will not be retried.
	// - **pending**: The transfer has been requested, and is pending.
	// - **pending_insert**: The transfer has completed and the domain will soon be inserted into the account.
	// - **pending_new_auth_code**: A new authcode is required to complete the transfer.
	// - **pending_transfer**: The transfer has been requested, and is pending.
	// - **pending_unlock**: The domain to be transferred is currently in a locked state at the losing registrar, and will begin processing once the lock has been removed.
	// - **rejected**: The transfer has been rejected at the losing registrar and will not be retried.
	// - **submitting_transfer**: The transfer has been initiated and will soon be submitted to the registry.
	Status DomainTransferStatusChangeStatus `json:"status"`
}

DomainTransferStatusChange defines model for DomainTransferStatusChange.

type DomainTransferStatusChangeStatus

type DomainTransferStatusChangeStatus string

DomainTransferStatusChangeStatus The updated status of the domain transfer. The transfer status will be one of the following values: - **canceled:** The transfer has been canceled by the user. - **canceled_pending_refund**: The transfer has been canceled by the user, and a refund for the price is being processed. - **completed**: The transfer has completed. - **failed**: The transfer has failed, and will not be retried. - **pending**: The transfer has been requested, and is pending. - **pending_insert**: The transfer has completed and the domain will soon be inserted into the account. - **pending_new_auth_code**: A new authcode is required to complete the transfer. - **pending_transfer**: The transfer has been requested, and is pending. - **pending_unlock**: The domain to be transferred is currently in a locked state at the losing registrar, and will begin processing once the lock has been removed. - **rejected**: The transfer has been rejected at the losing registrar and will not be retried. - **submitting_transfer**: The transfer has been initiated and will soon be submitted to the registry.

const (
	DomainTransferStatusChangeStatusCanceled              DomainTransferStatusChangeStatus = "canceled"
	DomainTransferStatusChangeStatusCanceledPendingRefund DomainTransferStatusChangeStatus = "canceled_pending_refund"
	DomainTransferStatusChangeStatusCompleted             DomainTransferStatusChangeStatus = "completed"
	DomainTransferStatusChangeStatusFailed                DomainTransferStatusChangeStatus = "failed"
	DomainTransferStatusChangeStatusPending               DomainTransferStatusChangeStatus = "pending"
	DomainTransferStatusChangeStatusPendingInsert         DomainTransferStatusChangeStatus = "pending_insert"
	DomainTransferStatusChangeStatusPendingNewAuthCode    DomainTransferStatusChangeStatus = "pending_new_auth_code"
	DomainTransferStatusChangeStatusPendingTransfer       DomainTransferStatusChangeStatus = "pending_transfer"
	DomainTransferStatusChangeStatusPendingUnlock         DomainTransferStatusChangeStatus = "pending_unlock"
	DomainTransferStatusChangeStatusRejected              DomainTransferStatusChangeStatus = "rejected"
	DomainTransferStatusChangeStatusSubmittingTransfer    DomainTransferStatusChangeStatus = "submitting_transfer"
)

Defines values for DomainTransferStatusChangeStatus.

type DomainsPurchasePrivacyBody

type DomainsPurchasePrivacyBody struct {
	// PurchasePrice PurchasePrice is the (prorated) amount you expect to pay.
	PurchasePrice *float64 `json:"purchasePrice,omitempty"`

	// Years Years is the number of years you wish to purchase Whois Privacy for. Years defaults to 1 and cannot be more then the domain expiration date.
	Years *int32 `json:"years,omitempty"`
}

DomainsPurchasePrivacyBody PrivacyRequest passes the domain name as well as the purchase parameters to the PurchasePrivacy function.

type DomainsRenewDomainBody

type DomainsRenewDomainBody struct {
	// PurchasePrice PurchasePrice is the amount in USD to pay for the domain renewal at the minimum renewal period (typically 1 year). If VAT tax applies, it will also be added automatically.
	// PurchasePrice is required if this is a premium domain.
	PurchasePrice *float64 `json:"purchasePrice,omitempty"`

	// Years Years specifies how many years to renew the domain for. Years defaults to the minimum time period (typically 1 year) if not passed and cannot be more than 10.  Some TLDs default to longer periods (e.g. .AI requires a 2 year renewal).
	Years *int32 `json:"years,omitempty"`
}

DomainsRenewDomainBody RenewDomainRequest passes the domain name and purchase parameters to the RenewDomain function.

type DomainsSetContactsBody

type DomainsSetContactsBody struct {
	// Contacts Contacts stores the contact information for the roles related to domains.
	Contacts *Contacts `json:"contacts,omitempty"`
}

DomainsSetContactsBody SetContactsRequest passes the contact info for each role to the SetContacts function.

type DomainsSetNameserversBody

type DomainsSetNameserversBody struct {
	// Nameservers Nameservers is a list of the nameservers to set. Nameservers should already be set up and hosting the zone properly as some registries will verify before allowing the change.
	Nameservers []string `json:"nameservers"`
}

DomainsSetNameserversBody SetNameserversRequest passes the list of nameservers to set for the SetNameserver function.

type EmailForwarding

type EmailForwarding struct {
	// DomainName DomainName is the domain part of the email address to forward.
	DomainName string `json:"domainName"`

	// EmailBox EmailBox is the user portion of the email address to forward.
	EmailBox string `json:"emailBox"`

	// EmailTo EmailTo is the entire email address to forward email to.
	EmailTo openapi_types.Email `json:"emailTo"`
}

EmailForwarding EmailForwarding contains all the information for an email forwarding entry.

type EmailForwardingsUpdateEmailForwardingBody

type EmailForwardingsUpdateEmailForwardingBody struct {
	// EmailTo EmailTo is the entire email address to forward email to.
	EmailTo *string `json:"emailTo,omitempty"`
}

EmailForwardingsUpdateEmailForwardingBody EmailForwarding contains all the information for an email forwarding entry.

type EnableAutorenewParams

type EnableAutorenewParams struct {
	// ContentType Required Content-Type Header for POST requests.
	ContentType EnableAutorenewParamsContentType `json:"Content-Type"`
}

EnableAutorenewParams defines parameters for EnableAutorenew.

type EnableAutorenewParamsContentType

type EnableAutorenewParamsContentType string

EnableAutorenewParamsContentType defines parameters for EnableAutorenew.

const (
	EnableAutorenewParamsContentTypeApplicationjson EnableAutorenewParamsContentType = "application/json"
)

Defines values for EnableAutorenewParamsContentType.

type EnableAutorenewResp

type EnableAutorenewResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Domain
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseEnableAutorenewResp

func ParseEnableAutorenewResp(rsp *http.Response) (*EnableAutorenewResp, error)

ParseEnableAutorenewResp parses an HTTP response from a EnableAutorenewWithResponse call

func (EnableAutorenewResp) Status

func (r EnableAutorenewResp) Status() string

Status returns HTTPResponse.Status

func (EnableAutorenewResp) StatusCode

func (r EnableAutorenewResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EnableWhoisPrivacyParams

type EnableWhoisPrivacyParams struct {
	// ContentType Required Content-Type Header for POST requests.
	ContentType EnableWhoisPrivacyParamsContentType `json:"Content-Type"`
}

EnableWhoisPrivacyParams defines parameters for EnableWhoisPrivacy.

type EnableWhoisPrivacyParamsContentType

type EnableWhoisPrivacyParamsContentType string

EnableWhoisPrivacyParamsContentType defines parameters for EnableWhoisPrivacy.

const (
	EnableWhoisPrivacyParamsContentTypeApplicationjson EnableWhoisPrivacyParamsContentType = "application/json"
)

Defines values for EnableWhoisPrivacyParamsContentType.

type EnableWhoisPrivacyResp

type EnableWhoisPrivacyResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Domain
	JSON400      *InvalidArgument400
	JSON401      *Unauthorized401
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseEnableWhoisPrivacyResp

func ParseEnableWhoisPrivacyResp(rsp *http.Response) (*EnableWhoisPrivacyResp, error)

ParseEnableWhoisPrivacyResp parses an HTTP response from a EnableWhoisPrivacyWithResponse call

func (EnableWhoisPrivacyResp) Status

func (r EnableWhoisPrivacyResp) Status() string

Status returns HTTPResponse.Status

func (EnableWhoisPrivacyResp) StatusCode

func (r EnableWhoisPrivacyResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ExpireDate

type ExpireDate = time.Time

ExpireDate The date and time when the domain will expire.

type GenericConflict409

type GenericConflict409 struct {
	// Details Additional context or information about the error
	Details *string `json:"details"`

	// Message A human-readable error message describing the conflict
	Message string `json:"message"`
}

GenericConflict409 A conflict error response.

type GenericError500

type GenericError500 struct {
	// Details Additional context or information about the error.
	Details *string `json:"details"`

	// Message A human-readable message providing more details about the error.
	Message string `json:"message"`
}

GenericError500 defines model for GenericError500.

type GenericError501

type GenericError501 struct {
	// Details Additional context or information about the error
	Details *string `json:"details"`

	// Message A human-readable message providing more details about the error
	Message string `json:"message"`
}

GenericError501 defines model for GenericError501.

type GenericForbidden403

type GenericForbidden403 struct {
	// Details Additional context or information about the error
	Details *string `json:"details"`

	// Message A human-readable message providing more details about the error
	Message string `json:"message"`
}

GenericForbidden403 defines model for GenericForbidden403.

type GetAuthCodeForDomainResp

type GetAuthCodeForDomainResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AuthCodeResponse
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON406      *GenericError500
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseGetAuthCodeForDomainResp

func ParseGetAuthCodeForDomainResp(rsp *http.Response) (*GetAuthCodeForDomainResp, error)

ParseGetAuthCodeForDomainResp parses an HTTP response from a GetAuthCodeForDomainWithResponse call

func (GetAuthCodeForDomainResp) Status

func (r GetAuthCodeForDomainResp) Status() string

Status returns HTTPResponse.Status

func (GetAuthCodeForDomainResp) StatusCode

func (r GetAuthCodeForDomainResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDNSSECResp

type GetDNSSECResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DNSSEC
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseGetDNSSECResp

func ParseGetDNSSECResp(rsp *http.Response) (*GetDNSSECResp, error)

ParseGetDNSSECResp parses an HTTP response from a GetDNSSECWithResponse call

func (GetDNSSECResp) Status

func (r GetDNSSECResp) Status() string

Status returns HTTPResponse.Status

func (GetDNSSECResp) StatusCode

func (r GetDNSSECResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDomainResp

type GetDomainResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DomainResponsePayload
	JSON401      *Unauthorized401
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseGetDomainResp

func ParseGetDomainResp(rsp *http.Response) (*GetDomainResp, error)

ParseGetDomainResp parses an HTTP response from a GetDomainWithResponse call

func (GetDomainResp) Status

func (r GetDomainResp) Status() string

Status returns HTTPResponse.Status

func (GetDomainResp) StatusCode

func (r GetDomainResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEmailForwardingResp

type GetEmailForwardingResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *EmailForwarding
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseGetEmailForwardingResp

func ParseGetEmailForwardingResp(rsp *http.Response) (*GetEmailForwardingResp, error)

ParseGetEmailForwardingResp parses an HTTP response from a GetEmailForwardingWithResponse call

func (GetEmailForwardingResp) Status

func (r GetEmailForwardingResp) Status() string

Status returns HTTPResponse.Status

func (GetEmailForwardingResp) StatusCode

func (r GetEmailForwardingResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderResp

type GetOrderResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Order
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
}

func ParseGetOrderResp

func ParseGetOrderResp(rsp *http.Response) (*GetOrderResp, error)

ParseGetOrderResp parses an HTTP response from a GetOrderWithResponse call

func (GetOrderResp) Status

func (r GetOrderResp) Status() string

Status returns HTTPResponse.Status

func (GetOrderResp) StatusCode

func (r GetOrderResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPricingForDomainParams

type GetPricingForDomainParams struct {
	// Years Years specifies the time period in years to get pricing for the domain. Years defaults to the minimum time period (typically 1 year) if not passed and cannot be more than 10.  Some TLDs default to longer periods (e.g. .AI requires 2 year periods).
	Years *int32 `form:"years,omitempty" json:"years,omitempty"`
}

GetPricingForDomainParams defines parameters for GetPricingForDomain.

type GetPricingForDomainResp

type GetPricingForDomainResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PricingResponse
	JSON400      *InvalidArgument400
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
}

func ParseGetPricingForDomainResp

func ParseGetPricingForDomainResp(rsp *http.Response) (*GetPricingForDomainResp, error)

ParseGetPricingForDomainResp parses an HTTP response from a GetPricingForDomainWithResponse call

func (GetPricingForDomainResp) Status

func (r GetPricingForDomainResp) Status() string

Status returns HTTPResponse.Status

func (GetPricingForDomainResp) StatusCode

func (r GetPricingForDomainResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRecordResp

type GetRecordResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Record
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseGetRecordResp

func ParseGetRecordResp(rsp *http.Response) (*GetRecordResp, error)

ParseGetRecordResp parses an HTTP response from a GetRecordWithResponse call

func (GetRecordResp) Status

func (r GetRecordResp) Status() string

Status returns HTTPResponse.Status

func (GetRecordResp) StatusCode

func (r GetRecordResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRequirementResp

type GetRequirementResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetRequirementResponse
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
}

func ParseGetRequirementResp

func ParseGetRequirementResp(rsp *http.Response) (*GetRequirementResp, error)

ParseGetRequirementResp parses an HTTP response from a GetRequirementWithResponse call

func (GetRequirementResp) Status

func (r GetRequirementResp) Status() string

Status returns HTTPResponse.Status

func (GetRequirementResp) StatusCode

func (r GetRequirementResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRequirementResponse

type GetRequirementResponse struct {
	// Requirements Requirement defines the registration requirements for a specific TLD, including required fields, validation rules, and conditional logic.
	Requirements Requirement `json:"requirements"`

	// TldInfo General information about a TLD and it's various requirements. This is not a comprehensive list of all information related to a TLD.
	TldInfo ResellerTldInfo `json:"tldInfo"`
}

GetRequirementResponse GetRequirementResponse has TLD Info and registration requirements for the specified TLD. The requirements field will always be present but may be an empty object when no specific requirements exist for the TLD.

type GetSubscribedNotificationsResp

type GetSubscribedNotificationsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListSubscribedWebhooksResponse
	JSON401      *Unauthorized401
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseGetSubscribedNotificationsResp

func ParseGetSubscribedNotificationsResp(rsp *http.Response) (*GetSubscribedNotificationsResp, error)

ParseGetSubscribedNotificationsResp parses an HTTP response from a GetSubscribedNotificationsWithResponse call

func (GetSubscribedNotificationsResp) Status

Status returns HTTPResponse.Status

func (GetSubscribedNotificationsResp) StatusCode

func (r GetSubscribedNotificationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTransferResp

type GetTransferResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Transfer
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseGetTransferResp

func ParseGetTransferResp(rsp *http.Response) (*GetTransferResp, error)

ParseGetTransferResp parses an HTTP response from a GetTransferWithResponse call

func (GetTransferResp) Status

func (r GetTransferResp) Status() string

Status returns HTTPResponse.Status

func (GetTransferResp) StatusCode

func (r GetTransferResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetURLForwardingResp

type GetURLForwardingResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *URLForwardingResponse
	JSON400      *InvalidArgument400
	JSON401      *Unauthorized401
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseGetURLForwardingResp

func ParseGetURLForwardingResp(rsp *http.Response) (*GetURLForwardingResp, error)

ParseGetURLForwardingResp parses an HTTP response from a GetURLForwardingWithResponse call

func (GetURLForwardingResp) Status

func (r GetURLForwardingResp) Status() string

Status returns HTTPResponse.Status

func (GetURLForwardingResp) StatusCode

func (r GetURLForwardingResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVanityNameserverResp

type GetVanityNameserverResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *VanityNameserverResponse
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseGetVanityNameserverResp

func ParseGetVanityNameserverResp(rsp *http.Response) (*GetVanityNameserverResp, error)

ParseGetVanityNameserverResp parses an HTTP response from a GetVanityNameserverWithResponse call

func (GetVanityNameserverResp) Status

func (r GetVanityNameserverResp) Status() string

Status returns HTTPResponse.Status

func (GetVanityNameserverResp) StatusCode

func (r GetVanityNameserverResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HelloResp

type HelloResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *HelloResponse
	JSON401      *Unauthorized401
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseHelloResp

func ParseHelloResp(rsp *http.Response) (*HelloResp, error)

ParseHelloResp parses an HTTP response from a HelloWithResponse call

func (HelloResp) Status

func (r HelloResp) Status() string

Status returns HTTPResponse.Status

func (HelloResp) StatusCode

func (r HelloResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HelloResponse

type HelloResponse struct {
	// Motd Motd is a message of the day. It might provide some useful information.
	Motd string `json:"motd"`

	// ServerName ServerName is an identfier for which server is being accessed.
	ServerName string `json:"serverName"`

	// ServerTime ServerTime is the current date/time at the server.
	ServerTime string `json:"serverTime"`

	// Username Username is the account name you are currently logged into.
	Username string `json:"username"`
}

HelloResponse defines model for HelloResponse.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InvalidArgument400

type InvalidArgument400 struct {
	// Details Additional context or information about the error
	Details *string `json:"details"`

	// Message A human-readable message providing more details about the error
	Message string `json:"message"`
}

InvalidArgument400 defines model for InvalidArgument400.

type ListDNSSECsResp

type ListDNSSECsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListDNSSECsResponse
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseListDNSSECsResp

func ParseListDNSSECsResp(rsp *http.Response) (*ListDNSSECsResp, error)

ParseListDNSSECsResp parses an HTTP response from a ListDNSSECsWithResponse call

func (ListDNSSECsResp) Status

func (r ListDNSSECsResp) Status() string

Status returns HTTPResponse.Status

func (ListDNSSECsResp) StatusCode

func (r ListDNSSECsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListDNSSECsResponse

type ListDNSSECsResponse struct {
	// Dnssec Dnssec is the list of registered DNSSEC keys.
	Dnssec []DNSSEC `json:"dnssec"`
}

ListDNSSECsResponse ListDNSSECsResponse contains the list of DS records at the registry.

type ListDomainsParams

type ListDomainsParams struct {
	// PerPage Per Page is the number of records to return per request. Per Page defaults to 1,000.
	PerPage *int32 `form:"perPage,omitempty" json:"perPage,omitempty"`

	// Page Page is which page to return.
	Page *int32 `form:"page,omitempty" json:"page,omitempty"`

	// Sort Sort specifies which domain property to order by.
	Sort *string `form:"sort,omitempty" json:"sort,omitempty"`

	// Dir Dir indicates direction of sort. Possible values are 'asc' (default) or 'desc'.
	Dir *string `form:"dir,omitempty" json:"dir,omitempty"`

	// DomainName DomainName filters domains by exact domain name or wildcard (starts with '*').
	DomainName *string `form:"domainName,omitempty" json:"domainName,omitempty"`

	// Tld Tld filters on specific tld.
	Tld *string `form:"tld,omitempty" json:"tld,omitempty"`

	// Locked Locked filters on locked domains.
	Locked *bool `form:"locked,omitempty" json:"locked,omitempty"`

	// CreateDate CreateDate filters domains created on this date.
	CreateDate *string `form:"createDate,omitempty" json:"createDate,omitempty"`

	// CreateDateStart CreateDateStart filters domains created on or after this date.
	CreateDateStart *string `form:"createDateStart,omitempty" json:"createDateStart,omitempty"`

	// CreateDateEnd CreateDateEnd filters domains created on or before this date.
	CreateDateEnd *string `form:"createDateEnd,omitempty" json:"createDateEnd,omitempty"`

	// ExpireDate ExpireDate filters domains expiring on this date.
	ExpireDate *string `form:"expireDate,omitempty" json:"expireDate,omitempty"`

	// ExpireDateStart ExpireDateStart filters domains with expire date on or after this date.
	ExpireDateStart *string `form:"expireDateStart,omitempty" json:"expireDateStart,omitempty"`

	// ExpireDateEnd ExpireDateEnd filters domains with expire date on or before this date.
	ExpireDateEnd *string `form:"expireDateEnd,omitempty" json:"expireDateEnd,omitempty"`

	// PrivacyEnabled PrivacyEnabled indicates whether there is a privacy product associated with the domain.
	PrivacyEnabled *bool `form:"privacyEnabled,omitempty" json:"privacyEnabled,omitempty"`

	// IsPremium IsPremium indicates whether the domain is a premium domain.
	IsPremium *bool `form:"isPremium,omitempty" json:"isPremium,omitempty"`

	// AutorenewEnabled AutorenewEnabled indicates if the domain will attempt to renew automatically before expiration.
	AutorenewEnabled *bool `form:"autorenewEnabled,omitempty" json:"autorenewEnabled,omitempty"`

	// OrderId OrderId specifies the order number of a domain purchase.
	OrderId *int32 `form:"orderId,omitempty" json:"orderId,omitempty"`
}

ListDomainsParams defines parameters for ListDomains.

type ListDomainsResp

type ListDomainsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListDomainsResponse
	JSON400      *InvalidArgument400
	JSON401      *Unauthorized401
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseListDomainsResp

func ParseListDomainsResp(rsp *http.Response) (*ListDomainsResp, error)

ParseListDomainsResp parses an HTTP response from a ListDomainsWithResponse call

func (ListDomainsResp) Status

func (r ListDomainsResp) Status() string

Status returns HTTPResponse.Status

func (ListDomainsResp) StatusCode

func (r ListDomainsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListDomainsResponse

type ListDomainsResponse struct {
	// Domains Domains is the list of domains in your account.
	Domains []DomainResponsePayload `json:"domains"`

	// From From is starting record count for current page.
	From int32 `json:"from"`

	// LastPage LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
	LastPage *int32 `json:"lastPage,omitempty"`

	// NextPage NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
	NextPage *int32 `json:"nextPage,omitempty"`

	// To To is ending record count for current page.
	To int32 `json:"to"`

	// TotalCount TotalCount is total number of domains returned for request.
	TotalCount int32 `json:"totalCount"`
}

ListDomainsResponse ListDomainsResponse is the response from a list request, it contains the paginated list of Domains.

type ListEmailForwardingsParams

type ListEmailForwardingsParams struct {
	// PerPage (optional) Per Page is the number of records to return per request. Per Page defaults to 1,000 if not set.
	PerPage *int32 `form:"perPage,omitempty" json:"perPage,omitempty"`

	// Page (optional) Page is which page to return. Default to page 1 if not set.
	Page *int32 `form:"page,omitempty" json:"page,omitempty"`
}

ListEmailForwardingsParams defines parameters for ListEmailForwardings.

type ListEmailForwardingsResp

type ListEmailForwardingsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListEmailForwardingsResponse
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseListEmailForwardingsResp

func ParseListEmailForwardingsResp(rsp *http.Response) (*ListEmailForwardingsResp, error)

ParseListEmailForwardingsResp parses an HTTP response from a ListEmailForwardingsWithResponse call

func (ListEmailForwardingsResp) Status

func (r ListEmailForwardingsResp) Status() string

Status returns HTTPResponse.Status

func (ListEmailForwardingsResp) StatusCode

func (r ListEmailForwardingsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListEmailForwardingsResponse

type ListEmailForwardingsResponse struct {
	// EmailForwarding EmailForwarding is the list of forwarded email boxes.
	EmailForwarding []EmailForwarding `json:"emailForwarding"`

	// LastPage LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
	LastPage *int32 `json:"lastPage,omitempty"`

	// NextPage NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
	NextPage *int32 `json:"nextPage,omitempty"`
}

ListEmailForwardingsResponse ListEmailForwardingsResponse returns the list of email forwarding entries as well as the pagination information.

type ListOrdersParams

type ListOrdersParams struct {
	// PerPage Per Page is the number of records to return per request. Per Page defaults to 1,000.
	PerPage *int32 `form:"perPage,omitempty" json:"perPage,omitempty"`

	// Page Page is which page to return.
	Page *int32 `form:"page,omitempty" json:"page,omitempty"`
}

ListOrdersParams defines parameters for ListOrders.

type ListOrdersResp

type ListOrdersResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListOrdersResponse
	JSON401      *Unauthorized401
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseListOrdersResp

func ParseListOrdersResp(rsp *http.Response) (*ListOrdersResp, error)

ParseListOrdersResp parses an HTTP response from a ListOrdersWithResponse call

func (ListOrdersResp) Status

func (r ListOrdersResp) Status() string

Status returns HTTPResponse.Status

func (ListOrdersResp) StatusCode

func (r ListOrdersResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListOrdersResponse

type ListOrdersResponse struct {
	// From From specifies starting record number on current page.
	From int32 `json:"from"`

	// LastPage LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
	LastPage *int32 `json:"lastPage,omitempty"`

	// NextPage NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
	NextPage *int32 `json:"nextPage,omitempty"`

	// Orders Orders is the collection of orders, if any, in the requesting account.
	Orders []Order `json:"orders"`

	// ParentAccountId ParentAccountId field is populated when requesting account has a parent account id.
	ParentAccountId *int32 `json:"parentAccountId,omitempty"`

	// To To specifies ending record number on current page.
	To int32 `json:"to"`

	// TotalCount TotalCount is total number of results.
	TotalCount int32 `json:"totalCount"`
}

ListOrdersResponse ListOrdersResponse is the response from a list request, it contains the paginated list of Orders.

type ListRecordsParams

type ListRecordsParams struct {
	// PerPage Per Page is the number of records to return per request. Per Page defaults to 1,000.
	PerPage *int32 `form:"perPage,omitempty" json:"perPage,omitempty"`

	// Page Page is which page to return.
	Page *int32 `form:"page,omitempty" json:"page,omitempty"`
}

ListRecordsParams defines parameters for ListRecords.

type ListRecordsResp

type ListRecordsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListRecordsResponse
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseListRecordsResp

func ParseListRecordsResp(rsp *http.Response) (*ListRecordsResp, error)

ParseListRecordsResp parses an HTTP response from a ListRecordsWithResponse call

func (ListRecordsResp) Status

func (r ListRecordsResp) Status() string

Status returns HTTPResponse.Status

func (ListRecordsResp) StatusCode

func (r ListRecordsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListRecordsResponse

type ListRecordsResponse struct {
	// From From specifies starting record number on current page.
	From int32 `json:"from"`

	// LastPage LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
	LastPage *int32 `json:"lastPage,omitempty"`

	// NextPage NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
	NextPage *int32   `json:"nextPage,omitempty"`
	Records  []Record `json:"records"`

	// To To specifies ending record number on current page.
	To int32 `json:"to"`

	// TotalCount TotalCount is total number of results.
	TotalCount int32 `json:"totalCount"`
}

ListRecordsResponse ListRecordsResponse is the response for the ListRecords function.

type ListSubscribedWebhooksResponse

type ListSubscribedWebhooksResponse struct {
	Subscriptions *[]SubscriptionRecord `json:"subscriptions,omitempty"`
}

ListSubscribedWebhooksResponse defines model for ListSubscribedWebhooksResponse.

type ListTransfersParams

type ListTransfersParams struct {
	// PerPage Per Page is the number of records to return per request. Per Page defaults to 1,000.
	PerPage *int32 `form:"perPage,omitempty" json:"perPage,omitempty"`

	// Page Page is which page to return.
	Page *int32 `form:"page,omitempty" json:"page,omitempty"`
}

ListTransfersParams defines parameters for ListTransfers.

type ListTransfersResp

type ListTransfersResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListTransfersResponse
	JSON401      *Unauthorized401
	JSON402      *PaymentRequired402
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseListTransfersResp

func ParseListTransfersResp(rsp *http.Response) (*ListTransfersResp, error)

ParseListTransfersResp parses an HTTP response from a ListTransfersWithResponse call

func (ListTransfersResp) Status

func (r ListTransfersResp) Status() string

Status returns HTTPResponse.Status

func (ListTransfersResp) StatusCode

func (r ListTransfersResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListTransfersResponse

type ListTransfersResponse struct {
	// From From specifies starting record number on current page.
	From int32 `json:"from"`

	// LastPage LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
	LastPage *int32 `json:"lastPage,omitempty"`

	// NextPage NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
	NextPage *int32 `json:"nextPage,omitempty"`

	// To To specifies ending record number on current page.
	To int32 `json:"to"`

	// TotalCount TotalCount is total number of results.
	TotalCount int32 `json:"totalCount"`

	// Transfers Transfers is a list of pending transfers
	Transfers []Transfer `json:"transfers"`
}

ListTransfersResponse ListTransfersResponse returns the list of pending transfers as well as the pagination information if relevant.

type ListURLForwardingsParams

type ListURLForwardingsParams struct {
	// PerPage Per Page is the number of records to return per request. Per Page defaults to 1,000.
	PerPage *int32 `form:"perPage,omitempty" json:"perPage,omitempty"`

	// Page Page is which page to return. Starts at 1 for first page.
	Page *int32 `form:"page,omitempty" json:"page,omitempty"`
}

ListURLForwardingsParams defines parameters for ListURLForwardings.

type ListURLForwardingsResp

type ListURLForwardingsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListURLForwardingsResponse
	JSON400      *InvalidArgument400
	JSON401      *Unauthorized401
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseListURLForwardingsResp

func ParseListURLForwardingsResp(rsp *http.Response) (*ListURLForwardingsResp, error)

ParseListURLForwardingsResp parses an HTTP response from a ListURLForwardingsWithResponse call

func (ListURLForwardingsResp) Status

func (r ListURLForwardingsResp) Status() string

Status returns HTTPResponse.Status

func (ListURLForwardingsResp) StatusCode

func (r ListURLForwardingsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListURLForwardingsResponse

type ListURLForwardingsResponse struct {
	// LastPage LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
	LastPage *int32 `json:"lastPage"`

	// NextPage NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
	NextPage *int32 `json:"nextPage"`

	// UrlForwarding URLForwarding is the list of URL forwarding entries.
	UrlForwarding []URLForwardingResponse `json:"urlForwarding"`
}

ListURLForwardingsResponse ListURLForwardingsResponse is the response for the ListURLForwardings function.

type ListVanityNameserversParams

type ListVanityNameserversParams struct {
	// PerPage The number of records to return per page. Defaults to 1000.
	PerPage *int32 `form:"perPage,omitempty" json:"perPage,omitempty"`

	// Page The page number to return.
	Page *int32 `form:"page,omitempty" json:"page,omitempty"`
}

ListVanityNameserversParams defines parameters for ListVanityNameservers.

type ListVanityNameserversResp

type ListVanityNameserversResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListVanityNameserversResponse
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseListVanityNameserversResp

func ParseListVanityNameserversResp(rsp *http.Response) (*ListVanityNameserversResp, error)

ParseListVanityNameserversResp parses an HTTP response from a ListVanityNameserversWithResponse call

func (ListVanityNameserversResp) Status

func (r ListVanityNameserversResp) Status() string

Status returns HTTPResponse.Status

func (ListVanityNameserversResp) StatusCode

func (r ListVanityNameserversResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListVanityNameserversResponse

type ListVanityNameserversResponse struct {
	// LastPage LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page. If no further pages exist, this field will be null.
	LastPage *int32 `json:"lastPage"`

	// NextPage NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page. If no further pages exist, this field will be null.
	NextPage *int32 `json:"nextPage"`

	// VanityNameservers VanityNameservers is the list of vanity nameservers associated with the domain. If no vanity nameservers are configured, this will be an empty array.
	VanityNameservers []VanityNameserverResponse `json:"vanityNameservers"`
}

ListVanityNameserversResponse ListVanityNameserversResponse returns the list of vanity nameservers for the domain.

type LockDomainParams

type LockDomainParams struct {
	// ContentType Required Content-Type Header for POST requests.
	ContentType LockDomainParamsContentType `json:"Content-Type"`
}

LockDomainParams defines parameters for LockDomain.

type LockDomainParamsContentType

type LockDomainParamsContentType string

LockDomainParamsContentType defines parameters for LockDomain.

const (
	LockDomainParamsContentTypeApplicationjson LockDomainParamsContentType = "application/json"
)

Defines values for LockDomainParamsContentType.

type LockDomainResp

type LockDomainResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Domain
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseLockDomainResp

func ParseLockDomainResp(rsp *http.Response) (*LockDomainResp, error)

ParseLockDomainResp parses an HTTP response from a LockDomainWithResponse call

func (LockDomainResp) Status

func (r LockDomainResp) Status() string

Status returns HTTPResponse.Status

func (LockDomainResp) StatusCode

func (r LockDomainResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Locked

type Locked = bool

Locked Indicates if the domain is locked, preventing transfers to another registrar.

type ModifySubscriptionJSONBody

type ModifySubscriptionJSONBody struct {
	// Active Optionally update if the subscription is currently active
	Active *bool `json:"active,omitempty"`

	// Url Optionally update the URL we send the webhook data to
	Url *string `json:"url,omitempty"`
	// contains filtered or unexported fields
}

ModifySubscriptionJSONBody defines parameters for ModifySubscription.

type ModifySubscriptionJSONBody0

type ModifySubscriptionJSONBody0 struct {
	Url string `json:"url"`
}

ModifySubscriptionJSONBody0 defines parameters for ModifySubscription.

type ModifySubscriptionJSONBody1

type ModifySubscriptionJSONBody1 struct {
	Active bool `json:"active"`
}

ModifySubscriptionJSONBody1 defines parameters for ModifySubscription.

type ModifySubscriptionJSONRequestBody

type ModifySubscriptionJSONRequestBody ModifySubscriptionJSONBody

ModifySubscriptionJSONRequestBody defines body for ModifySubscription for application/json ContentType.

type ModifySubscriptionResp

type ModifySubscriptionResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ModifySubscriptionResponse
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseModifySubscriptionResp

func ParseModifySubscriptionResp(rsp *http.Response) (*ModifySubscriptionResp, error)

ParseModifySubscriptionResp parses an HTTP response from a ModifySubscriptionWithResponse call

func (ModifySubscriptionResp) Status

func (r ModifySubscriptionResp) Status() string

Status returns HTTPResponse.Status

func (ModifySubscriptionResp) StatusCode

func (r ModifySubscriptionResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ModifySubscriptionResponse

type ModifySubscriptionResponse struct {
	Subscription *SubscriptionRecord `json:"subscription,omitempty"`
}

ModifySubscriptionResponse defines model for ModifySubscriptionResponse.

type Nameservers

type Nameservers = []string

Nameservers The list of nameservers assigned to this domain. If unspecified, it defaults to the account's default nameservers.

type NotFound404

type NotFound404 struct {
	// Details Additional context or information about the error
	Details *string `json:"details"`

	// Message A human-readable message providing more details about the error
	Message string `json:"message"`
}

NotFound404 defines model for NotFound404.

type Order

type Order struct {
	// AuthAmount AuthAmount is the amount authorized to complete the order purchase.
	AuthAmount *float32 `json:"authAmount,omitempty"`

	// CreateDate CreateDate is the date the order was placed.
	CreateDate *string `json:"createDate,omitempty"`

	// Currency Currency indicates currency of the order ('USD', 'CNY').
	Currency *string `json:"currency,omitempty"`

	// CurrencyRate CurrencyRate is the conversion rate from USD to order's currency.  This field is only populated if order's currency is non-USD.
	CurrencyRate *float32 `json:"currencyRate,omitempty"`

	// FinalAmount FinalAmount is the final amount of the order, after discounts and refunds.
	FinalAmount *float32 `json:"finalAmount,omitempty"`
	Id          *int32   `json:"id,omitempty"`

	// OrderItems OrderItems is the collection of 1 or more items in the order.
	OrderItems *[]OrderItem `json:"orderItems,omitempty"`

	// Registrar Registrar is registrar with which order is placed.
	Registrar *string `json:"registrar,omitempty"`

	// Status Status indicates the state of the order ('success', 'failed').
	Status *string `json:"status,omitempty"`

	// TotalCapture TotalCapture is the amount captured.
	TotalCapture *float32 `json:"totalCapture,omitempty"`

	// TotalRefund TotalRefund is the amount, if any, refunded. Default is 0.00.
	TotalRefund *float32 `json:"totalRefund,omitempty"`
}

Order Order contains all the data for an order.

type OrderItem

type OrderItem struct {
	// Duration Duration is the number of intervals.
	Duration int32 `json:"duration"`
	Id       int32 `json:"id"`

	// Interval Interval is the  unit of time ("year", "month"). May be null for items that have no applicable interval.
	Interval *string `json:"interval"`

	// Name Name is name of the item ('example.ninja').
	Name *string `json:"name"`

	// OriginalPrice OriginalPrice is the original price of the item before discounts.
	OriginalPrice *float32 `json:"originalPrice"`

	// Price Price is the final price of the item.
	Price float32 `json:"price"`

	// PriceNonUsd PriceNonUsd is the price of the item if order has non-usd currency.
	PriceNonUsd *float32 `json:"priceNonUsd,omitempty"`

	// Quantity Quantity is the number of items.
	Quantity int32 `json:"quantity"`

	// Status Status indicates state of the order ('success', 'failed', 'refunded').
	Status string `json:"status"`

	// TaxAmount TaxAmount is the tax charged for this item, if applicable.
	TaxAmount *float32 `json:"taxAmount"`

	// Tld Tld is (optional) tld of domain name, if applicable ('ninja').
	Tld *string `json:"tld"`

	// Type Type is type of  the item ('registration', 'whois_privacy').
	Type string `json:"type"`
}

OrderItem OrderItem contains all the order item data.

type PaymentRequired402

type PaymentRequired402 struct {
	// Details Additional context or information about the error
	Details *string `json:"details"`

	// Message A human-readable message providing more details about the error
	Message string `json:"message"`
}

PaymentRequired402 defines model for PaymentRequired402.

type PremiumDomainListsResp

type PremiumDomainListsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PremiumDomainsDownloadResponse
	JSON401      *Unauthorized401
	JSON403      *GenericForbidden403
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParsePremiumDomainListsResp

func ParsePremiumDomainListsResp(rsp *http.Response) (*PremiumDomainListsResp, error)

ParsePremiumDomainListsResp parses an HTTP response from a PremiumDomainListsWithResponse call

func (PremiumDomainListsResp) Status

func (r PremiumDomainListsResp) Status() string

Status returns HTTPResponse.Status

func (PremiumDomainListsResp) StatusCode

func (r PremiumDomainListsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PremiumDomainsDownloadResponse

type PremiumDomainsDownloadResponse struct {
	// DownloadUrl The pre-signed URL to use to download the list.
	DownloadUrl *string `json:"downloadUrl,omitempty"`

	// ExpireDate The timestamp that the URL will expire.
	ExpireDate *time.Time `json:"expireDate,omitempty"`
}

PremiumDomainsDownloadResponse defines model for PremiumDomainsDownloadResponse.

type PricingResponse

type PricingResponse struct {
	// Premium Premium indicates that this pricing is a premium result and the respective prices must be passed in create, renew or transfer commands.
	Premium bool `json:"premium"`

	// PurchasePrice PurchasePrice is the price you will pay to register a domain. Can be passed in the CreateDomain request. If purchasePrice returns as null, it means that name.com is not currently accepting registrations for this combination of TLD and duration. If this is unexpected, please contact support.
	PurchasePrice *float64 `json:"purchasePrice"`

	// RenewalPrice RenewalPrice is the price you will pay to renew a domain. Can be passed in the RenewDomain request. If renewalPrice returns as null, it means that name.com is not currently accepting renewals for this combination of TLD and duration. If this is unexpected, please contact support.
	RenewalPrice *float64 `json:"renewalPrice"`

	// TransferPrice TransferPrice is the price you will pay to transfer a domain. Can be passed in the CreateTransfer request. The TransferPrice is always for 1 year regardless of the years input. If transferPrice returns as null, it means that name.com is not currently accepting transfers for this combination of TLD and duration. If this is unexpected, please contact support.
	TransferPrice *float64 `json:"transferPrice"`
}

PricingResponse PricingResponse returns the Pricing related information from the GetPricingForDomain function.

type PrivacyEnabled

type PrivacyEnabled = bool

PrivacyEnabled Indicates if Whois Privacy is enabled for this domain.

type PrivacyResponse

type PrivacyResponse struct {
	// Domain The response format for a domain.
	Domain *DomainResponsePayload `json:"domain,omitempty"`

	// Order Order is an identifier for this purchase.
	Order int32 `json:"order"`

	// TotalPaid TotalPaid is the total amount paid, including VAT.
	TotalPaid float64 `json:"totalPaid"`
}

PrivacyResponse PrivacyResponse contains the updated domain info as well as the order info for the newly purchased Whois Privacy.

type PurchasePrivacyJSONRequestBody

type PurchasePrivacyJSONRequestBody = DomainsPurchasePrivacyBody

PurchasePrivacyJSONRequestBody defines body for PurchasePrivacy for application/json ContentType.

type PurchasePrivacyParams

type PurchasePrivacyParams struct {
	// XIdempotencyKey A unique string (e.g., a UUID v4) to make the request idempotent. This key ensures that if the request is retried, the operation will not be performed multiple times. Subsequent requests with the same key will return the original result.
	XIdempotencyKey *string `json:"X-Idempotency-Key,omitempty"`
}

PurchasePrivacyParams defines parameters for PurchasePrivacy.

type PurchasePrivacyResp

type PurchasePrivacyResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrivacyResponse
	JSON401      *Unauthorized401
	JSON402      *PaymentRequired402
	JSON409      *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON415 *UnsupportedMedia415
	JSON429 *TooManyRequests429
	JSON500 *GenericError500
}

func ParsePurchasePrivacyResp

func ParsePurchasePrivacyResp(rsp *http.Response) (*PurchasePrivacyResp, error)

ParsePurchasePrivacyResp parses an HTTP response from a PurchasePrivacyWithResponse call

func (PurchasePrivacyResp) Status

func (r PurchasePrivacyResp) Status() string

Status returns HTTPResponse.Status

func (PurchasePrivacyResp) StatusCode

func (r PurchasePrivacyResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Record

type Record struct {
	// Answer Answer is either the IP address for A or AAAA records; the target for ANAME, CNAME, MX, or NS records; the text for TXT records.
	// For SRV records, answer has the following format: "{weight} {port} {target}" e.g. "1 5061 sip.example.org".
	Answer *string `json:"answer,omitempty"`

	// DomainName DomainName is the zone that the record belongs to.
	DomainName *string `json:"domainName,omitempty"`

	// Fqdn FQDN is the Fully Qualified Domain Name. It is the combination of the host and the domain name. It always ends in a ".". FQDN is ignored in CreateRecord, specify via the Host field instead.
	Fqdn *string `json:"fqdn,omitempty"`

	// Host Host is the hostname relative to the zone: e.g. for a record for blog.example.org, domain would be "example.org" and host would be "blog".
	// An apex record would be specified by either an empty host "" or "@".
	// A SRV record would be specified by "_{service}._{protocol}.{host}": e.g. "_sip._tcp.phone" for _sip._tcp.phone.example.org.
	Host *string `json:"host"`

	// Id Unique record id. Value is ignored on Create, and must match the URI on Update.
	Id *int32 `json:"id,omitempty"`

	// Priority Priority is only required for MX and SRV records, it is ignored for all others.
	Priority *int64 `json:"priority,omitempty"`

	// Ttl TTL is the time this record can be cached for in seconds. name.com allows a minimum TTL of 300, or 5 minutes.
	Ttl int64 `json:"ttl"`

	// Type Type is one of the following: A, AAAA, ANAME, CNAME, MX, NS, SRV, or TXT.
	Type *string `json:"type"`
}

Record Record is an individual DNS resource record.

type RegistrantContact

type RegistrantContact struct {
	// Address1 The first line of the contact's address.
	Address1 string `json:"address1"`

	// Address2 The second line of the contact's address (optional).
	Address2 *string `json:"address2"`

	// City City of the contact's address.
	City string `json:"city"`

	// CompanyName Company name of the contact. Leave blank if the contact is an individual. Please be advised that ICANN policy links the "Company Name" field (Organization) in your domain's contact details to its legal ownership. If this field contains information, the listed organization is considered the legal "Registered Name Holder" (domain owner).
	CompanyName *string `json:"companyName"`

	// Country Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
	Country string `json:"country"`

	// Email Email address of the contact. Must be a valid email format. The validation is performed against the `addr-spec` syntax in [RFC 822](https://datatracker.ietf.org/doc/html/rfc822)
	Email openapi_types.Email `json:"email"`

	// Fax Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
	Fax *string `json:"fax"`

	// FirstName First name of the contact.
	FirstName string `json:"firstName"`

	// IsVerified Indicates if the contact has been verified as per ICANN requirements. If the value is `false` it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.
	IsVerified *bool `json:"isVerified,omitempty"`

	// LastName Last name of the contact.
	LastName string `json:"lastName"`

	// Phone Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
	Phone string `json:"phone"`

	// State State or Province of the contact's address.
	State string `json:"state"`

	// Zip ZIP or Postal Code of the contact's address.
	Zip string `json:"zip"`
}

RegistrantContact Contact contains all relevant contact data for a domain registrant.

type RenewDomainJSONRequestBody

type RenewDomainJSONRequestBody = DomainsRenewDomainBody

RenewDomainJSONRequestBody defines body for RenewDomain for application/json ContentType.

type RenewDomainResp

type RenewDomainResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *RenewDomainResponse
	JSON400      *InvalidArgument400
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON422      *UnprocessableEntity422
	JSON429      *TooManyRequests429
}

func ParseRenewDomainResp

func ParseRenewDomainResp(rsp *http.Response) (*RenewDomainResp, error)

ParseRenewDomainResp parses an HTTP response from a RenewDomainWithResponse call

func (RenewDomainResp) Status

func (r RenewDomainResp) Status() string

Status returns HTTPResponse.Status

func (RenewDomainResp) StatusCode

func (r RenewDomainResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RenewDomainResponse

type RenewDomainResponse struct {
	// Domain Domain contains all relevant data for a domain.
	Domain *Domain `json:"domain,omitempty"`
	Order  *int32  `json:"order,omitempty"`

	// TotalPaid TotalPaid is the total amount paid, including VAT.
	TotalPaid *float64 `json:"totalPaid,omitempty"`
}

RenewDomainResponse RenewDomainResponse contains the updated domain info as well as the order info for the renewed domain.

type RenewalPrice

type RenewalPrice = float64

RenewalPrice The cost to renew the domain. This may be required for the RenewDomain operation.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type Requirement

type Requirement struct {
	// Description A detailed description of the registration requirements for this TLD, including eligibility criteria, restrictions, and important notes.
	Description *string `json:"description,omitempty"`

	// Fields An object containing all required and optional fields for domain registration, with their validation rules and conditional logic.
	Fields *map[string]RequirementField `json:"fields,omitempty"`
}

Requirement Requirement defines the registration requirements for a specific TLD, including required fields, validation rules, and conditional logic.

type RequirementField

type RequirementField struct {
	// Description A detailed description of what this field is for and any specific requirements or constraints.
	Description *string `json:"description,omitempty"`

	// Fields For complex fields or when options are selected, contains nested field definitions that become relevant.
	Fields *map[string]RequirementField `json:"fields"`

	// Label A user-friendly label for this field that can be used in UI forms.
	Label *string `json:"label,omitempty"`

	// Options For fields with predefined choices, this can be either an array of complex option objects, a simple array of string values, or null if no options are available.
	Options *RequirementField_Options `json:"options,omitempty"`

	// Required Whether this field is mandatory for domain registration. If true, the field must be provided.
	Required RequirementField_Required `json:"required"`

	// RequiredWhen For conditional fields, specifies when this field becomes required (e.g., when a parent option has a specific value).
	RequiredWhen *string `json:"required_when"`

	// Type The requirement type of this field. Each requirement type has different information.
	//
	// Possible values and their details:
	//
	//   - **`string`**: These are open string fields that cannot be submitted as empty. They will always have a label. A description is optional as the label may convey all of the required information the user would need to submit.
	//       Note: Some string fields may have a required format (i.e. date format of YYYY/MM/DD). The format will be listed in the "validation" parameter if required.
	//       Example TLDs: abogado, law, com.br (and more)
	//
	//   - **`notice`**: These field types will just have a description, and contain information that must be displayed to the user prior to registration. There is no data that will be required to be submitted, so all notice type fields will have a "required" value of `false`.
	//       Example TLDs: at (notice only), ca (1 notice field)
	//
	//   - **`acknowledgement`**: These field types will have a description, label and value. The description must be displayed to the user, the label is the required label for the acknowledgement, and the value is what must be submitted.
	//       Example TLDs: security, ngo, music (and more)
	//
	//   - **`enum`**: The field types have a list of predefined options that the user must choose from in order to submit. Only the values returned in the "options" array will be allowed, or the request will fail validation. Options MAY include dependent fields, as some registries required additional information depending on what was chosen for the "parent" option. All dependent fields will follow the same field patterns as the parent fields.
	//       Options: These are the predefined options for the enum type fields. They will always have a label and a value. The value is what must be submitted. The options MAY include a description, but will mostly only have a label parameter.
	//       Note: There may be a single option returned for an enum. This is because that is the ONLY OPTION ALLOWED by the registry.
	//       Example TLDs with simple lists: ca, es (and more)
	//       Example TLDs with dependent fields: fr, se, com.br
	//
	//   - **`boolean`**: Boolean fields for simple true/false acknowledgements or selections.
	//       Example TLDs: security
	Type interface{} `json:"type"`

	// Validation Validation rule to apply to this field. Common validations include 'valid_email', 'valid_phone', etc.
	Validation *string `json:"validation"`

	// Value For acknowledgement fields, this is the value that must be submitted when the user acknowledges the requirement.
	Value *string `json:"value"`
}

RequirementField A field definition for TLD registration requirements, including validation rules, conditional logic, and nested field structures.

type RequirementFieldOption

type RequirementFieldOption struct {
	// Fields When this option is selected, these nested fields become relevant and may be required. This allows for conditional field logic.
	Fields *map[string]RequirementField `json:"fields"`

	// Label A user-friendly label for this option that can be displayed in UI forms.
	Label *string `json:"label,omitempty"`

	// Value The actual value of this option. This is what must be submitted when this option is selected.
	Value string `json:"value"`
}

RequirementFieldOption An option within a field that has predefined choices, including the option value, label, and any nested fields that become relevant when this option is selected.

type RequirementFieldOptions0

type RequirementFieldOptions0 = []RequirementFieldOption

RequirementFieldOptions0 defines model for .

type RequirementFieldOptions1

type RequirementFieldOptions1 = []string

RequirementFieldOptions1 defines model for .

type RequirementFieldRequired0

type RequirementFieldRequired0 = bool

RequirementFieldRequired0 defines model for .

type RequirementFieldRequired1

type RequirementFieldRequired1 = string

RequirementFieldRequired1 defines model for .

type RequirementField_Options

type RequirementField_Options struct {
	// contains filtered or unexported fields
}

RequirementField_Options For fields with predefined choices, this can be either an array of complex option objects, a simple array of string values, or null if no options are available.

func (RequirementField_Options) AsRequirementFieldOptions0

func (t RequirementField_Options) AsRequirementFieldOptions0() (RequirementFieldOptions0, error)

AsRequirementFieldOptions0 returns the union data inside the RequirementField_Options as a RequirementFieldOptions0

func (RequirementField_Options) AsRequirementFieldOptions1

func (t RequirementField_Options) AsRequirementFieldOptions1() (RequirementFieldOptions1, error)

AsRequirementFieldOptions1 returns the union data inside the RequirementField_Options as a RequirementFieldOptions1

func (*RequirementField_Options) FromRequirementFieldOptions0

func (t *RequirementField_Options) FromRequirementFieldOptions0(v RequirementFieldOptions0) error

FromRequirementFieldOptions0 overwrites any union data inside the RequirementField_Options as the provided RequirementFieldOptions0

func (*RequirementField_Options) FromRequirementFieldOptions1

func (t *RequirementField_Options) FromRequirementFieldOptions1(v RequirementFieldOptions1) error

FromRequirementFieldOptions1 overwrites any union data inside the RequirementField_Options as the provided RequirementFieldOptions1

func (RequirementField_Options) MarshalJSON

func (t RequirementField_Options) MarshalJSON() ([]byte, error)

func (*RequirementField_Options) MergeRequirementFieldOptions0

func (t *RequirementField_Options) MergeRequirementFieldOptions0(v RequirementFieldOptions0) error

MergeRequirementFieldOptions0 performs a merge with any union data inside the RequirementField_Options, using the provided RequirementFieldOptions0

func (*RequirementField_Options) MergeRequirementFieldOptions1

func (t *RequirementField_Options) MergeRequirementFieldOptions1(v RequirementFieldOptions1) error

MergeRequirementFieldOptions1 performs a merge with any union data inside the RequirementField_Options, using the provided RequirementFieldOptions1

func (*RequirementField_Options) UnmarshalJSON

func (t *RequirementField_Options) UnmarshalJSON(b []byte) error

type RequirementField_Required

type RequirementField_Required struct {
	// contains filtered or unexported fields
}

RequirementField_Required Whether this field is mandatory for domain registration. If true, the field must be provided.

func (RequirementField_Required) AsRequirementFieldRequired0

func (t RequirementField_Required) AsRequirementFieldRequired0() (RequirementFieldRequired0, error)

AsRequirementFieldRequired0 returns the union data inside the RequirementField_Required as a RequirementFieldRequired0

func (RequirementField_Required) AsRequirementFieldRequired1

func (t RequirementField_Required) AsRequirementFieldRequired1() (RequirementFieldRequired1, error)

AsRequirementFieldRequired1 returns the union data inside the RequirementField_Required as a RequirementFieldRequired1

func (*RequirementField_Required) FromRequirementFieldRequired0

func (t *RequirementField_Required) FromRequirementFieldRequired0(v RequirementFieldRequired0) error

FromRequirementFieldRequired0 overwrites any union data inside the RequirementField_Required as the provided RequirementFieldRequired0

func (*RequirementField_Required) FromRequirementFieldRequired1

func (t *RequirementField_Required) FromRequirementFieldRequired1(v RequirementFieldRequired1) error

FromRequirementFieldRequired1 overwrites any union data inside the RequirementField_Required as the provided RequirementFieldRequired1

func (RequirementField_Required) MarshalJSON

func (t RequirementField_Required) MarshalJSON() ([]byte, error)

func (*RequirementField_Required) MergeRequirementFieldRequired0

func (t *RequirementField_Required) MergeRequirementFieldRequired0(v RequirementFieldRequired0) error

MergeRequirementFieldRequired0 performs a merge with any union data inside the RequirementField_Required, using the provided RequirementFieldRequired0

func (*RequirementField_Required) MergeRequirementFieldRequired1

func (t *RequirementField_Required) MergeRequirementFieldRequired1(v RequirementFieldRequired1) error

MergeRequirementFieldRequired1 performs a merge with any union data inside the RequirementField_Required, using the provided RequirementFieldRequired1

func (*RequirementField_Required) UnmarshalJSON

func (t *RequirementField_Required) UnmarshalJSON(b []byte) error

type ResellerTldInfo

type ResellerTldInfo struct {
	// AllowedRegistrationYears The years that a domain is allowed to be registered for.
	AllowedRegistrationYears []float32 `json:"allowedRegistrationYears"`

	// CcTld Whether the TLD is a Country Code TLD.
	CcTld bool `json:"ccTld"`

	// ExpirationGracePeriod The number of days you have to renew your domain after it has expired, but before it is removed from your account.
	ExpirationGracePeriod int32 `json:"expirationGracePeriod"`

	// Hsts The entire TLD namespace has been added to the HSTS Preload list. As such, all second-level domains under .TLD will only load on modern browsers if a valid SSL certificate has been configured and the webserver is serving HTTPS.
	Hsts bool `json:"hsts"`

	// IdnLanguages The IND Languages that the TLD supports (if any).
	IdnLanguages map[string]string `json:"idnLanguages"`

	// MinDomainLength The minimum allowed length for the second level domain (SLD) for a given TLD. The SLD would be the `example` part of `example.com`. Attempts to register a domain with a shorter length than allowed will result in a failure of a Create Domain request.
	MinDomainLength int32 `json:"minDomainLength"`

	// MinIdnDomainLength The minimum allowed length for the second level domain (SLD) that utilizes an IDN character for a given TLD.  The SLD would be the `èxample` part of `èxample.com`. Attempts to register a domain with a shorter length than allowed will result in a failure of a Create Domain request. This value will often be different from the `minDomainLength` for non-IDN registrations.  This parameter will return as `null` for any TLDs that do not support IDN registrations.
	MinIdnDomainLength *int32 `json:"minIdnDomainLength"`

	// RegistryOperator The registry that operates the given TLD.
	RegistryOperator string `json:"registryOperator"`

	// RequiresPreDelegation Whether this TLD requires pre-delegation. If this is true, these domains must be added to the name servers before the domain creation is completed.
	RequiresPreDelegation bool `json:"requiresPreDelegation"`

	// SupportsDnssec Whether the TLD supports DNSSEC.
	SupportsDnssec bool `json:"supportsDnssec"`

	// SupportsPremium Whether there are premium domains for this TLD.
	SupportsPremium bool `json:"supportsPremium"`

	// SupportsPrivacy Whether the TLD supports WHOIS Privacy.
	SupportsPrivacy bool `json:"supportsPrivacy"`

	// SupportsTransferLock Whether the TLD supports implementing a Transfer Lock.
	SupportsTransferLock bool `json:"supportsTransferLock"`

	// Tld The TLD this information relates to.
	Tld string `json:"tld"`
}

ResellerTldInfo General information about a TLD and it's various requirements. This is not a comprehensive list of all information related to a TLD.

type SearchJSONRequestBody

type SearchJSONRequestBody = SearchRequest

SearchJSONRequestBody defines body for Search for application/json ContentType.

type SearchRequest

type SearchRequest struct {
	// Keyword Keyword is the search term to search for. It can be just a word, or a whole domain name.
	Keyword string `json:"keyword"`

	// Timeout Timeout is a value in milliseconds on how long to perform the search for. Valid timeouts are between 500ms to 12,000ms. If not specified, timeout defaults to 12,000ms.
	// Since some additional processing is performed on the results, a response may take longer then the timeout.
	Timeout *int32 `json:"timeout,omitempty"`

	// TldFilter TLDFilter will limit results to only contain the specified TLDs. There is a maximum of 50 TLDs that can be used in this filter
	TldFilter *[]string `json:"tldFilter,omitempty"`
}

SearchRequest SearchRequest is used to specify the search parameters.

type SearchResp

type SearchResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SearchResponse
	JSON400      *InvalidArgument400
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseSearchResp

func ParseSearchResp(rsp *http.Response) (*SearchResp, error)

ParseSearchResp parses an HTTP response from a SearchWithResponse call

func (SearchResp) Status

func (r SearchResp) Status() string

Status returns HTTPResponse.Status

func (SearchResp) StatusCode

func (r SearchResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchResponse

type SearchResponse struct {
	// Results Results of the search are returned here, the order should not be relied upon.
	Results *[]SearchResult `json:"results,omitempty"`
}

SearchResponse SearchResponse returns a list of search results.

type SearchResult

type SearchResult struct {
	// DomainName DomainName is the punycode encoding of the result domain name.
	DomainName string `json:"domainName"`

	// Premium Premium indicates that this search result is a premium result and the purchase_price needs to be passed to the DomainCreate command. This parameter will only be returned for domains that are purchasable.
	Premium *bool `json:"premium,omitempty"`

	// Purchasable Purchasable indicates whether the search result is available for purchase.
	Purchasable bool `json:"purchasable"`

	// PurchasePrice PurchasePrice is the price for purchasing this domain for the minimum time period (typically 1 year). Purchase_price is always in USD. This parameter will only be returned for domains that are purchasable.
	PurchasePrice *float64 `json:"purchasePrice,omitempty"`

	// PurchaseType PurchaseType indicates what kind of purchase this result is for. It should be passed to the DomainCreate command. This parameter will only be returned for domains that are purchasable.
	PurchaseType *string `json:"purchaseType,omitempty"`

	// RenewalPrice RenewalPrice is the annual renewal price for this domain as it may be different than the purchase_price. This parameter will only be returned for domains that are purchasable.
	RenewalPrice *float64 `json:"renewalPrice,omitempty"`

	// Sld SLD is first portion of the domain_name.
	Sld string `json:"sld"`

	// Tld TLD is the rest of the domain_name after the SLD.
	Tld string `json:"tld"`
}

SearchResult SearchResult is returned by the CheckAvailability, Search, and SearchStream functions.

type SetContactsJSONRequestBody

type SetContactsJSONRequestBody = DomainsSetContactsBody

SetContactsJSONRequestBody defines body for SetContacts for application/json ContentType.

type SetContactsResp

type SetContactsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DomainResponsePayload
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseSetContactsResp

func ParseSetContactsResp(rsp *http.Response) (*SetContactsResp, error)

ParseSetContactsResp parses an HTTP response from a SetContactsWithResponse call

func (SetContactsResp) Status

func (r SetContactsResp) Status() string

Status returns HTTPResponse.Status

func (SetContactsResp) StatusCode

func (r SetContactsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SetNameserversJSONRequestBody

type SetNameserversJSONRequestBody = DomainsSetNameserversBody

SetNameserversJSONRequestBody defines body for SetNameservers for application/json ContentType.

type SetNameserversResp

type SetNameserversResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DomainResponsePayload
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseSetNameserversResp

func ParseSetNameserversResp(rsp *http.Response) (*SetNameserversResp, error)

ParseSetNameserversResp parses an HTTP response from a SetNameserversWithResponse call

func (SetNameserversResp) Status

func (r SetNameserversResp) Status() string

Status returns HTTPResponse.Status

func (SetNameserversResp) StatusCode

func (r SetNameserversResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubscribeToNotification

type SubscribeToNotification struct {
	// Active If the webhook should be active. This allows a webhook to be deactivated in our system. It may be useful to deactivate a webhook if the server that receives the POST request is undergoing scheduled maintenance, for example.
	Active bool `json:"active"`

	// EventName The list of configured webhooks you can subscribe to
	EventName AvailableWebhooks `json:"eventName"`

	// Url The URL we will send the notification data to
	Url string `json:"url"`
}

SubscribeToNotification Request to subscribe to a specific webhook notification

type SubscribeToNotificationJSONRequestBody

type SubscribeToNotificationJSONRequestBody = SubscribeToNotification

SubscribeToNotificationJSONRequestBody defines body for SubscribeToNotification for application/json ContentType.

type SubscribeToNotificationResp

type SubscribeToNotificationResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *SubscribeToNotificationResponse
	JSON401      *Unauthorized401
	JSON409      *Conflict409
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseSubscribeToNotificationResp

func ParseSubscribeToNotificationResp(rsp *http.Response) (*SubscribeToNotificationResp, error)

ParseSubscribeToNotificationResp parses an HTTP response from a SubscribeToNotificationWithResponse call

func (SubscribeToNotificationResp) Status

Status returns HTTPResponse.Status

func (SubscribeToNotificationResp) StatusCode

func (r SubscribeToNotificationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubscribeToNotificationResponse

type SubscribeToNotificationResponse struct {
	Subscription *SubscriptionRecord `json:"subscription,omitempty"`
}

SubscribeToNotificationResponse defines model for SubscribeToNotificationResponse.

type SubscriptionRecord

type SubscriptionRecord struct {
	Active     bool    `json:"active"`
	CreateDate string  `json:"createDate"`
	EventName  string  `json:"eventName"`
	Id         int32   `json:"id"`
	UpdateDate *string `json:"updateDate"`
	Url        string  `json:"url"`
}

SubscriptionRecord defines model for SubscriptionRecord.

type TldPriceListEntry

type TldPriceListEntry struct {
	// DomainRestorationPrice This your account level price in US Dollars (USD) and is the price you pay for domain restorations. It includes applicable rebates, promotions and/or sales.
	DomainRestorationPrice *float64 `json:"domainRestorationPrice"`

	// Duration The number of years this pricing is for
	Duration int32 `json:"duration"`

	// RegistrationOriginalPrice Price in US Dollars (USD) before any rebates, promotions and/or sales when registering non-premium domains.
	RegistrationOriginalPrice *float64 `json:"registrationOriginalPrice"`

	// RegistrationPrice This your account level price in US Dollars (USD) and is the price you pay for non-premium registrations. It includes applicable rebates, promotions and/or sales.
	RegistrationPrice *float64 `json:"registrationPrice"`

	// RenewalPrice This your account level price in US Dollars (USD) and is the price you pay for renewals. It includes applicable rebates, promotions and/or sales.
	RenewalPrice *float64 `json:"renewalPrice"`

	// Tld The TLD the pricing applies to. For IDN TLDs, this will be the unicode representation of the TLD.
	Tld string `json:"tld"`

	// TransferInPrice This your account level price in US Dollars (USD) and is the price you pay for transferring a domain to management at name.com. It includes applicable rebates, promotions and/or sales.
	TransferInPrice *float64 `json:"transferInPrice"`
}

TldPriceListEntry The pricing for an individual TLD.

Please note that if `null` is returned for any of the prices, it means that particular product is unavailable at name.com.

For example, if `registrationPrice` returns as `null` in the response, it means that name.com is not currently accepting registrations for that TLD.

type TldPriceListParams

type TldPriceListParams struct {
	// PerPage Per Page is the number of records to return per request. Per Page defaults to 25.
	PerPage *int32 `form:"perPage,omitempty" json:"perPage,omitempty"`

	// Page Page is which page to return.
	Page *int32 `form:"page,omitempty" json:"page,omitempty"`

	// Duration The number of years to get pricing for. The requested duration must be between 1 and 10 (inclusive). If the duration is not passed in the request, it will default to 1.
	Duration *int32 `form:"duration,omitempty" json:"duration,omitempty"`

	// Tlds A list of specific TLDs to get pricing for. Maximum of 25 TLDs can be requested at a time.  When querying for IDN TLDs, due to character restrictions within a URL, they must be submitted in ASCII format.  This means using "xn--9dbq2a" as opposed to it's unicode equivalent. The submitted TLDs will be checked for validity and support at name.com, and any invalid TLD will be removed from the submitted list. If all submitted TLDs are invalid or not supported by name.com, this will be considered a bad request, and a `400 Bad Request` will be returned with an appropriate message.
	Tlds *[]string `form:"tlds,omitempty" json:"tlds,omitempty"`
}

TldPriceListParams defines parameters for TldPriceList.

type TldPriceListResp

type TldPriceListResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TldPriceListResponse
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseTldPriceListResp

func ParseTldPriceListResp(rsp *http.Response) (*TldPriceListResp, error)

ParseTldPriceListResp parses an HTTP response from a TldPriceListWithResponse call

func (TldPriceListResp) Status

func (r TldPriceListResp) Status() string

Status returns HTTPResponse.Status

func (TldPriceListResp) StatusCode

func (r TldPriceListResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TldPriceListResponse

type TldPriceListResponse struct {
	// From From specifies starting record number on current page.
	From int32 `json:"from"`

	// LastPage LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
	LastPage int32 `json:"lastPage"`

	// NextPage NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
	NextPage *int32              `json:"nextPage"`
	Pricing  []TldPriceListEntry `json:"pricing"`

	// To To specifies ending record number on current page.
	To int32 `json:"to"`

	// TotalCount TotalCount is total number of results.
	TotalCount int32 `json:"totalCount"`
}

TldPriceListResponse defines model for TldPriceListResponse.

type TooManyRequests429

type TooManyRequests429 struct {
	// Message A human-readable message providing more details about the error
	Message *string `json:"message,omitempty"`
}

TooManyRequests429 defines model for TooManyRequests429.

type Transfer

type Transfer struct {
	// DomainName DomainName is the domain to be transfered to name.com.
	DomainName string `json:"domainName"`

	// Email Email is the email address that the approval email was sent to. Not every TLD requries an approval email. This is usually pulled from Whois.
	Email *openapi_types.Email `json:"email,omitempty"`

	// Status The updated status of the domain transfer. The transfer status will be one of the following values:
	//   - **canceled:** The transfer has been canceled by the user.
	//   - **canceled_pending_refund**: The transfer has been canceled by the user, and a refund for the price is being processed.
	//   - **completed**: The transfer has completed.
	//   - **failed**: The transfer has failed, and will not be retried.
	//   - **pending**: The transfer has been requested, and is pending.
	//   - **pending_insert**: The transfer has completed and the domain will soon be inserted into the account.
	//   - **pending_new_auth_code**: A new authcode is required to complete the transfer.
	//   - **pending_transfer**: The transfer has been requested, and is pending.
	//   - **pending_unlock**: The domain to be transferred is currently in a locked state at the losing registrar, and will begin processing once the lock has been removed.
	//   - **rejected**: The transfer has been rejected at the losing registrar and will not be retried.
	//   - **submitting_transfer**: The transfer has been initiated and will soon be submitted to the registry.
	Status TransferStatus `json:"status"`
}

Transfer Transfer contains all relevant data for a domain transfer to name.com.

type TransferStatus

type TransferStatus string

TransferStatus The updated status of the domain transfer. The transfer status will be one of the following values:

  • **canceled:** The transfer has been canceled by the user.
  • **canceled_pending_refund**: The transfer has been canceled by the user, and a refund for the price is being processed.
  • **completed**: The transfer has completed.
  • **failed**: The transfer has failed, and will not be retried.
  • **pending**: The transfer has been requested, and is pending.
  • **pending_insert**: The transfer has completed and the domain will soon be inserted into the account.
  • **pending_new_auth_code**: A new authcode is required to complete the transfer.
  • **pending_transfer**: The transfer has been requested, and is pending.
  • **pending_unlock**: The domain to be transferred is currently in a locked state at the losing registrar, and will begin processing once the lock has been removed.
  • **rejected**: The transfer has been rejected at the losing registrar and will not be retried.
  • **submitting_transfer**: The transfer has been initiated and will soon be submitted to the registry.
const (
	TransferStatusCanceled              TransferStatus = "canceled"
	TransferStatusCanceledPendingRefund TransferStatus = "canceled_pending_refund"
	TransferStatusCompleted             TransferStatus = "completed"
	TransferStatusFailed                TransferStatus = "failed"
	TransferStatusPending               TransferStatus = "pending"
	TransferStatusPendingInsert         TransferStatus = "pending_insert"
	TransferStatusPendingNewAuthCode    TransferStatus = "pending_new_auth_code"
	TransferStatusPendingTransfer       TransferStatus = "pending_transfer"
	TransferStatusPendingUnlock         TransferStatus = "pending_unlock"
	TransferStatusRejected              TransferStatus = "rejected"
	TransferStatusSubmittingTransfer    TransferStatus = "submitting_transfer"
)

Defines values for TransferStatus.

type URLForwarding

type URLForwarding struct {
	// DomainName The domain name (without subdomains) that is being forwarded.
	DomainName *string `json:"domainName,omitempty"`

	// ForwardsTo The destination URL to which this hostname will be forwarded.
	ForwardsTo string `json:"forwardsTo"`

	// Host The subdomain portion of the hostname that is being forwarded.
	Host string `json:"host"`

	// Meta Meta tags to include in the HTML page when using "masked" forwarding.
	// Ignored for other forwarding types.
	// Example: `<meta name='keywords' content='fish, denver, platte'>`
	Meta *string `json:"meta"`

	// Title The title to be used for the HTML page when using "masked" forwarding.
	// Ignored for other forwarding types.
	Title *string `json:"title"`

	// Type The type of URL forwarding. Valid values:
	//   - `masked`: Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
	//   - `redirect`: Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
	//   - `302`: Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
	Type URLForwardingType `json:"type"`
}

URLForwarding URLForwarding represents a URL forwarding entry, allowing a domain to redirect to another URL using different forwarding methods.

type URLForwardingResponse

type URLForwardingResponse struct {
	// DomainName The domain name (without subdomains) that is being forwarded.
	DomainName *string `json:"domainName,omitempty"`

	// ForwardsTo The destination URL to which this hostname will be forwarded.
	ForwardsTo string `json:"forwardsTo"`

	// Host The complete hostname that is being forwarded (subdomain + domain).
	Host string `json:"host"`

	// Meta Meta tags to include in the HTML page when using "masked" forwarding.
	// Ignored for other forwarding types.
	// Example: `<meta name='keywords' content='fish, denver, platte'>`
	Meta *string `json:"meta"`

	// Title The title to be used for the HTML page when using "masked" forwarding.
	// Ignored for other forwarding types.
	Title *string `json:"title"`

	// Type The type of URL forwarding. Valid values:
	//   - `masked`: Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
	//   - `redirect`: Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
	//   - `302`: Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
	Type URLForwardingResponseType `json:"type"`
}

URLForwardingResponse defines model for URLForwardingResponse.

type URLForwardingResponseType

type URLForwardingResponseType string

URLForwardingResponseType The type of URL forwarding. Valid values:

  • `masked`: Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
  • `redirect`: Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
  • `302`: Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
const (
	URLForwardingResponseTypeMasked   URLForwardingResponseType = "masked"
	URLForwardingResponseTypeN302     URLForwardingResponseType = "302"
	URLForwardingResponseTypeRedirect URLForwardingResponseType = "redirect"
)

Defines values for URLForwardingResponseType.

type URLForwardingType

type URLForwardingType string

URLForwardingType The type of URL forwarding. Valid values:

  • `masked`: Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
  • `redirect`: Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
  • `302`: Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
const (
	URLForwardingTypeMasked   URLForwardingType = "masked"
	URLForwardingTypeN302     URLForwardingType = "302"
	URLForwardingTypeRedirect URLForwardingType = "redirect"
)

Defines values for URLForwardingType.

type Unauthorized401

type Unauthorized401 struct {
	// Message A human-readable message providing more details about the error
	Message string `json:"message"`
}

Unauthorized401 defines model for Unauthorized401.

type UnavailableForLegal451

type UnavailableForLegal451 struct {
	// Details Additional context or information about the legal restriction
	Details *string `json:"details,omitempty"`

	// Message A human-readable message explaining why the resource is unavailable for legal reasons
	Message string `json:"message"`
}

UnavailableForLegal451 defines model for UnavailableForLegal451.

type UnlockDomainParams

type UnlockDomainParams struct {
	// ContentType Required Content-Type Header for POST requests.
	ContentType UnlockDomainParamsContentType `json:"Content-Type"`
}

UnlockDomainParams defines parameters for UnlockDomain.

type UnlockDomainParamsContentType

type UnlockDomainParamsContentType string

UnlockDomainParamsContentType defines parameters for UnlockDomain.

const (
	UnlockDomainParamsContentTypeApplicationjson UnlockDomainParamsContentType = "application/json"
)

Defines values for UnlockDomainParamsContentType.

type UnlockDomainResp

type UnlockDomainResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Domain
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseUnlockDomainResp

func ParseUnlockDomainResp(rsp *http.Response) (*UnlockDomainResp, error)

ParseUnlockDomainResp parses an HTTP response from a UnlockDomainWithResponse call

func (UnlockDomainResp) Status

func (r UnlockDomainResp) Status() string

Status returns HTTPResponse.Status

func (UnlockDomainResp) StatusCode

func (r UnlockDomainResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UnprocessableEntity422

type UnprocessableEntity422 struct {
	// Details Additional context or information about the pricing error
	Details *string `json:"details,omitempty"`

	// Message A human-readable message providing more details about the error
	Message string `json:"message"`
}

UnprocessableEntity422 defines model for UnprocessableEntity422.

type UnsupportedMedia415

type UnsupportedMedia415 struct {
	// Message A human-readable message providing more details about the error
	Message string `json:"message"`
}

UnsupportedMedia415 defines model for UnsupportedMedia415.

type UnverifiedContact

type UnverifiedContact struct {
	// CreateDate The date the record requiring verification was created.
	CreateDate *time.Time `json:"createDate,omitempty"`

	// Domains A list of the domains that the contact verification record is applied to.
	Domains []string `json:"domains"`

	// Email The email address of the contact to be verified. This is the primary identifier used for verification.
	Email *openapi_types.Email `json:"email,omitempty"`

	// VerificationId The id of the verification record for the contact. Please note, this is different than the `contact_id` that may be returned in other API contexts. This id specifically relates to the verification and will be different than an `contact_id` for the same contact record in other contexts.
	VerificationId int64 `json:"verificationId"`

	// VerifyBy The date/time that the contact record **must** be verified by.  If the contact record is not verified by this date, the domain may become locked by the registry. This is typically 15 days from the creation date of the verification record, but may vary by TLD and registry.
	VerifyBy *time.Time `json:"verifyBy,omitempty"`
}

UnverifiedContact The pertinent information used to identifiy a domain contact that requires verification as per ICANN requirements.

type UnverifiedContactsListParams

type UnverifiedContactsListParams struct {
	// PerPage PerPage is the number of records to return per request. If not passed in the request, the default value is 100 records.
	PerPage *int32 `form:"perPage,omitempty" json:"perPage,omitempty"`

	// Page Page is which page to return. If not passed in the request, the default page is 1.
	Page *int32 `form:"page,omitempty" json:"page,omitempty"`
}

UnverifiedContactsListParams defines parameters for UnverifiedContactsList.

type UnverifiedContactsListResp

type UnverifiedContactsListResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *UnverifiedContactsResponse
	JSON401      *Unauthorized401
	JSON403      *GenericForbidden403
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseUnverifiedContactsListResp

func ParseUnverifiedContactsListResp(rsp *http.Response) (*UnverifiedContactsListResp, error)

ParseUnverifiedContactsListResp parses an HTTP response from a UnverifiedContactsListWithResponse call

func (UnverifiedContactsListResp) Status

Status returns HTTPResponse.Status

func (UnverifiedContactsListResp) StatusCode

func (r UnverifiedContactsListResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UnverifiedContactsResponse

type UnverifiedContactsResponse struct {
	// From From is the starting record for the current page.
	From int32 `json:"from"`

	// LastPage LastPage is the identifier for the final page of results. This value will be null if there is not a previous result page.
	LastPage int32 `json:"lastPage"`

	// NextPage NextPage is the identifier for the next page of results. This value will be null if there is not a next page of results.
	NextPage *int32 `json:"nextPage"`

	// To To is the ending record for the current page.
	To int32 `json:"to"`

	// TotalCount TotalCount is total number of domains returned for request.
	TotalCount         int32               `json:"totalCount"`
	UnverifiedContacts []UnverifiedContact `json:"unverifiedContacts"`
}

UnverifiedContactsResponse A list of unverified contacts that relate to your account.

type UpdateDomainJSONBody

type UpdateDomainJSONBody struct {
	// AutorenewEnabled Enable or disable automatic renewal for the domain.
	AutorenewEnabled *bool `json:"autorenewEnabled,omitempty"`

	// Locked Set the transfer lock status for the domain
	Locked *bool `json:"locked,omitempty"`

	// PrivacyEnabled Enable or disable Whois privacy for the domain.
	PrivacyEnabled *bool `json:"privacyEnabled,omitempty"`
	// contains filtered or unexported fields
}

UpdateDomainJSONBody defines parameters for UpdateDomain.

type UpdateDomainJSONBody0

type UpdateDomainJSONBody0 struct {
	AutorenewEnabled bool `json:"autorenewEnabled"`
}

UpdateDomainJSONBody0 defines parameters for UpdateDomain.

type UpdateDomainJSONBody1

type UpdateDomainJSONBody1 struct {
	PrivacyEnabled bool `json:"privacyEnabled"`
}

UpdateDomainJSONBody1 defines parameters for UpdateDomain.

type UpdateDomainJSONBody2

type UpdateDomainJSONBody2 struct {
	Locked bool `json:"locked"`
}

UpdateDomainJSONBody2 defines parameters for UpdateDomain.

type UpdateDomainJSONRequestBody

type UpdateDomainJSONRequestBody UpdateDomainJSONBody

UpdateDomainJSONRequestBody defines body for UpdateDomain for application/json ContentType.

type UpdateDomainResp

type UpdateDomainResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DomainResponsePayload
	JSON400      *InvalidArgument400
	JSON403      *InvalidArgument400
	JSON404      *NotFound404
	JSON409      *GenericConflict409
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseUpdateDomainResp

func ParseUpdateDomainResp(rsp *http.Response) (*UpdateDomainResp, error)

ParseUpdateDomainResp parses an HTTP response from a UpdateDomainWithResponse call

func (UpdateDomainResp) Status

func (r UpdateDomainResp) Status() string

Status returns HTTPResponse.Status

func (UpdateDomainResp) StatusCode

func (r UpdateDomainResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateEmailForwardingJSONRequestBody

type UpdateEmailForwardingJSONRequestBody = EmailForwardingsUpdateEmailForwardingBody

UpdateEmailForwardingJSONRequestBody defines body for UpdateEmailForwarding for application/json ContentType.

type UpdateEmailForwardingResp

type UpdateEmailForwardingResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *EmailForwarding
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseUpdateEmailForwardingResp

func ParseUpdateEmailForwardingResp(rsp *http.Response) (*UpdateEmailForwardingResp, error)

ParseUpdateEmailForwardingResp parses an HTTP response from a UpdateEmailForwardingWithResponse call

func (UpdateEmailForwardingResp) Status

func (r UpdateEmailForwardingResp) Status() string

Status returns HTTPResponse.Status

func (UpdateEmailForwardingResp) StatusCode

func (r UpdateEmailForwardingResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateRecordJSONRequestBody

type UpdateRecordJSONRequestBody = DNSUpdateRecordBody

UpdateRecordJSONRequestBody defines body for UpdateRecord for application/json ContentType.

type UpdateRecordResp

type UpdateRecordResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Record
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseUpdateRecordResp

func ParseUpdateRecordResp(rsp *http.Response) (*UpdateRecordResp, error)

ParseUpdateRecordResp parses an HTTP response from a UpdateRecordWithResponse call

func (UpdateRecordResp) Status

func (r UpdateRecordResp) Status() string

Status returns HTTPResponse.Status

func (UpdateRecordResp) StatusCode

func (r UpdateRecordResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateURLForwardingBody

type UpdateURLForwardingBody struct {
	DomainName interface{} `json:"domainName,omitempty"`

	// ForwardsTo The destination URL to which this hostname will be forwarded.
	ForwardsTo string      `json:"forwardsTo"`
	Host       interface{} `json:"host,omitempty"`

	// Meta Meta tags to include in the HTML page when using "masked" forwarding.
	// Ignored for other forwarding types.
	// Example: `<meta name='keywords' content='fish, denver, platte'>`
	Meta *string `json:"meta"`

	// Title The title to be used for the HTML page when using "masked" forwarding.
	// Ignored for other forwarding types.
	Title *string `json:"title"`

	// Type The type of URL forwarding. Valid values:
	//   - `masked`: Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
	//   - `redirect`: Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
	//   - `302`: Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
	Type UpdateURLForwardingBodyType `json:"type"`
}

UpdateURLForwardingBody defines model for UpdateURLForwardingBody.

type UpdateURLForwardingBodyType

type UpdateURLForwardingBodyType string

UpdateURLForwardingBodyType The type of URL forwarding. Valid values:

  • `masked`: Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
  • `redirect`: Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
  • `302`: Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
const (
	Masked   UpdateURLForwardingBodyType = "masked"
	N302     UpdateURLForwardingBodyType = "302"
	Redirect UpdateURLForwardingBodyType = "redirect"
)

Defines values for UpdateURLForwardingBodyType.

type UpdateURLForwardingJSONRequestBody

type UpdateURLForwardingJSONRequestBody = UpdateURLForwardingBody

UpdateURLForwardingJSONRequestBody defines body for UpdateURLForwarding for application/json ContentType.

type UpdateURLForwardingResp

type UpdateURLForwardingResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *URLForwardingResponse
	JSON400      *InvalidArgument400
	JSON401      *Unauthorized401
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseUpdateURLForwardingResp

func ParseUpdateURLForwardingResp(rsp *http.Response) (*UpdateURLForwardingResp, error)

ParseUpdateURLForwardingResp parses an HTTP response from a UpdateURLForwardingWithResponse call

func (UpdateURLForwardingResp) Status

func (r UpdateURLForwardingResp) Status() string

Status returns HTTPResponse.Status

func (UpdateURLForwardingResp) StatusCode

func (r UpdateURLForwardingResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateVanityNameserverBody

type UpdateVanityNameserverBody struct {
	// Ips IPs is the updated list of IP addresses to be used for glue records for this vanity nameserver. Providing an empty array will remove all existing IPs.
	Ips *[]string `json:"ips,omitempty"`
}

UpdateVanityNameserverBody UpdateVanityNameserverBody contains the list of IP addresses to update for a vanity nameserver.

type UpdateVanityNameserverJSONRequestBody

type UpdateVanityNameserverJSONRequestBody = UpdateVanityNameserverBody

UpdateVanityNameserverJSONRequestBody defines body for UpdateVanityNameserver for application/json ContentType.

type UpdateVanityNameserverResp

type UpdateVanityNameserverResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *VanityNameserverResponse
	JSON400      *InvalidArgument400
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON415      *UnsupportedMedia415
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
}

func ParseUpdateVanityNameserverResp

func ParseUpdateVanityNameserverResp(rsp *http.Response) (*UpdateVanityNameserverResp, error)

ParseUpdateVanityNameserverResp parses an HTTP response from a UpdateVanityNameserverWithResponse call

func (UpdateVanityNameserverResp) Status

Status returns HTTPResponse.Status

func (UpdateVanityNameserverResp) StatusCode

func (r UpdateVanityNameserverResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type VanityNameserver

type VanityNameserver struct {
	// DomainName DomainName is the root domain for which this vanity nameserver is created. For example, if the hostname is 'ns1.example.com', the domainName would be 'example.com'.
	DomainName string `json:"domainName"`

	// Hostname Hostname is the fully qualified domain name (FQDN) of the vanity nameserver. It must be a subdomain of the domain specified in 'domainName'.
	Hostname string `json:"hostname"`

	// Ips IPs is a list of IP addresses that are used for glue records for this vanity nameserver. These should be valid IPv4 or IPv6 addresses.
	Ips []string `json:"ips"`
}

VanityNameserver VanityNameserver represents a custom nameserver associated with a domain, including its hostname and a list of IP addresses for glue records.

type VanityNameserverResponse

type VanityNameserverResponse struct {
	// DomainName DomainName is the root domain for which this vanity nameserver is created. For example, if the hostname is 'ns1.example.com', the domainName would be 'example.com'.
	DomainName string `json:"domainName"`

	// Hostname Hostname is the fully qualified domain name (FQDN) of the vanity nameserver. It must be a subdomain of the domain specified in 'domainName'.
	Hostname string `json:"hostname"`

	// Ips IPs is a list of IP addresses that are used for glue records for this vanity nameserver. These should be valid IPv4 or IPv6 addresses.
	Ips []string `json:"ips"`
}

VanityNameserverResponse defines model for VanityNameserverResponse.

type VerifyContactParams

type VerifyContactParams struct {
	// XIdempotencyKey A unique string (e.g., a UUID v4) to make the request idempotent. This key ensures that if the request is retried, the operation will not be performed multiple times. Subsequent requests with the same key will return the original result.
	XIdempotencyKey *string `json:"X-Idempotency-Key,omitempty"`
}

VerifyContactParams defines parameters for VerifyContact.

type VerifyContactResp

type VerifyContactResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON401      *Unauthorized401
	JSON403      *GenericForbidden403
	JSON404      *NotFound404
	JSON409      *struct {
		Message *string `json:"message,omitempty"`
	}
	JSON429 *TooManyRequests429
	JSON500 *GenericError500
}

func ParseVerifyContactResp

func ParseVerifyContactResp(rsp *http.Response) (*VerifyContactResp, error)

ParseVerifyContactResp parses an HTTP response from a VerifyContactWithResponse call

func (VerifyContactResp) Status

func (r VerifyContactResp) Status() string

Status returns HTTPResponse.Status

func (VerifyContactResp) StatusCode

func (r VerifyContactResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ZoneCheckJSONRequestBody

type ZoneCheckJSONRequestBody = ZoneCheckRequest

ZoneCheckJSONRequestBody defines body for ZoneCheck for application/json ContentType.

type ZoneCheckRequest

type ZoneCheckRequest struct {
	// DomainNames Array of domains to check
	DomainNames []string `json:"domainNames"`
}

ZoneCheckRequest ZoneCheck request checks DNS zone files for the availability of the specified domains.

type ZoneCheckResp

type ZoneCheckResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ZoneCheckResponse
	JSON400      *InvalidArgument400
	JSON415      *UnsupportedMedia415
	JSON422      *UnprocessableEntity422
	JSON429      *TooManyRequests429
	JSON500      *GenericError500
	JSON502      *BadGateway502
}

func ParseZoneCheckResp

func ParseZoneCheckResp(rsp *http.Response) (*ZoneCheckResp, error)

ParseZoneCheckResp parses an HTTP response from a ZoneCheckWithResponse call

func (ZoneCheckResp) Status

func (r ZoneCheckResp) Status() string

Status returns HTTPResponse.Status

func (ZoneCheckResp) StatusCode

func (r ZoneCheckResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ZoneCheckResponse

type ZoneCheckResponse struct {
	// Removed Total number of domains removed from the check because they are invalid
	Removed *int32            `json:"removed,omitempty"`
	Results []ZoneCheckResult `json:"results"`

	// Total Total number of records checked
	Total int32 `json:"total"`
}

ZoneCheckResponse Response for checking domain availability via DNS zone checks.

type ZoneCheckResult

type ZoneCheckResult struct {
	// Available If the domain is potentially available for purchase after checking for it's presense in the DNZ zone files.
	Available *bool `json:"available"`

	// DomainName The domain name that was checked
	DomainName string `json:"domainName"`
}

ZoneCheckResult Result for checking and individual domain's presense in DNS zone files.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL