@rqt/namecheap/types/externs/index.js

An Implementation Of The Namecheap.com API.

/**
 * @fileoverview
 * @externs
 */

/* typal types/index.xml externs */
/** @const */
var _namecheap = {}
/**
 * Options for the NameCheap client.
 * @typedef {{ user: string, key: string, ip: string, sandbox: (boolean|undefined) }}
 */
_namecheap.Options

/* typal types/api/index.xml externs */
/**
 * The client API.
 * @interface
 */
_namecheap.NameCheap
/**
 * Domains operations.
 * @type {_namecheap.DomainsAPI}
 */
_namecheap.NameCheap.prototype.domains
/**
 * Address operations.
 * @type {_namecheap.AddressAPI}
 */
_namecheap.NameCheap.prototype.address
/**
 * User operations.
 * @type {_namecheap.UsersAPI}
 */
_namecheap.NameCheap.prototype.users
/**
 * DNS operations.
 * @type {_namecheap.DnsAPI}
 */
_namecheap.NameCheap.prototype.dns
/**
 * The domains API.
 * @record
 */
_namecheap.DomainsAPI
/**
 * Returns a list of domains for the particular user.
 * @param {!_namecheap.GetList} options The options to get the list of domains.
 * @return {!Promise<{ domains: !Array<!_namecheap.Domain>, TotalItems: number, CurrentPage: number, PageSize: number }>}
 */
_namecheap.DomainsAPI.prototype.getList = function(options) {}
/**
 * Returns information about the requested domain.
 * @param {(string|!_namecheap.GetInfo)} options The domain, or all get-info options.
 * @return {!Promise<!_namecheap.DomainInfo>}
 */
_namecheap.DomainsAPI.prototype.getInfo = function(options) {}
/**
 * Check if the domain name is taken.
 * @param {(string|!_namecheap.Check)} options The domain, or all check options.
 * @return {!Promise<!Array<!_namecheap.DomainCheck>>}
 */
_namecheap.DomainsAPI.prototype.check = function(options) {}
/**
 * Register a domain.
 * @param {!_namecheap.Create} options How to create a domain.
 * @return {!Promise<!_namecheap.RegistrationResult>}
 */
_namecheap.DomainsAPI.prototype.create = function(options) {}
/**
 * The address API.
 * @record
 */
_namecheap.AddressAPI
/**
 * Gets a list of address IDs and address names associated with the user account.
 * @return {!Promise<!Array<!_namecheap.Address>>}
 */
_namecheap.AddressAPI.prototype.getList = function() {}
/**
 * Gets information for the requested address ID.
 * @param {(string|number)} id The address id.
 * @return {!Promise<!_namecheap.AddressDetail>}
 */
_namecheap.AddressAPI.prototype.getInfo = function(id) {}
/**
 * The users API.
 * @record
 */
_namecheap.UsersAPI
/**
 * Returns pricing information for a requested product type.
 * @param {!_namecheap.GetPricing} options Options
 * @return {!Promise<!_namecheap.Pricing>}
 */
_namecheap.UsersAPI.prototype.getPricing = function(options) {}
/**
 * The DNS API.
 * @record
 */
_namecheap.DnsAPI
/**
 * Retrieves DNS host record settings for the requested domain.
 * @param {string} domain The domain name.
 * @return {!Promise<{ hosts: !Array<!_namecheap.Host>, IsUsingOurDNS: boolean, Domain: string, EmailType: string }>}
 */
_namecheap.DnsAPI.prototype.getHosts = function(domain) {}
/**
 * Sets the host records.
 * @param {string} domain The domain name for which to set records.
 * @param {!Array<!_namecheap.HostParams>} hosts The array of all hosts to set.
 * @param {!_namecheap.DNSSetOptions=} [options] Optional parameters.
 * @return {!Promise<{ Domain: string, IsSuccess: boolean }>}
 */
_namecheap.DnsAPI.prototype.setHosts = function(domain, hosts, options) {}