TopLevelDomains interface

Interface representing a TopLevelDomains.

Methods

get(string, TopLevelDomainsGetOptionalParams)

Description for Get details of a top-level domain.

list(TopLevelDomainsListOptionalParams)

Description for Get all top-level domains supported for registration.

listAgreements(string, TopLevelDomainAgreementOption, TopLevelDomainsListAgreementsOptionalParams)

Description for Gets all legal agreements that user needs to accept before purchasing a domain.

Method Details

get(string, TopLevelDomainsGetOptionalParams)

Description for Get details of a top-level domain.

function get(name: string, options?: TopLevelDomainsGetOptionalParams): Promise<TopLevelDomain>

Parameters

name

string

Name of the top-level domain.

options
TopLevelDomainsGetOptionalParams

The options parameters.

Returns

Promise<TopLevelDomain>

list(TopLevelDomainsListOptionalParams)

Description for Get all top-level domains supported for registration.

function list(options?: TopLevelDomainsListOptionalParams): PagedAsyncIterableIterator<TopLevelDomain, TopLevelDomain[], PageSettings>

Parameters

options
TopLevelDomainsListOptionalParams

The options parameters.

Returns

listAgreements(string, TopLevelDomainAgreementOption, TopLevelDomainsListAgreementsOptionalParams)

Description for Gets all legal agreements that user needs to accept before purchasing a domain.

function listAgreements(name: string, agreementOption: TopLevelDomainAgreementOption, options?: TopLevelDomainsListAgreementsOptionalParams): PagedAsyncIterableIterator<TldLegalAgreement, TldLegalAgreement[], PageSettings>

Parameters

name

string

Name of the top-level domain.

agreementOption
TopLevelDomainAgreementOption

Domain agreement options.

options
TopLevelDomainsListAgreementsOptionalParams

The options parameters.

Returns