@jesseditson/dnsimple/dist/lib/tlds.d.ts

A Node.JS client for the DNSimple API.

import type { DNSimple, QueryParams } from "./main";
import type * as types from "./types";
export declare class Tlds {
    private readonly _client;
    constructor(_client: DNSimple);
    /**
     * Lists TLDs supported for registration or transfer.
     *
     * This API is paginated. Call `listTlds.iterateAll(params)` to get an asynchronous iterator over individual items across all pages. You can also use `await listTlds.collectAll(params)` to quickly retrieve all items across all pages into an array. We suggest using `iterateAll` when possible, as `collectAll` will make all requests at once, which may increase latency and trigger rate limits.
     *
     * GET /tlds
     *
     * @see https://developer.dnsimple.com/v2/tlds/#listTlds
     *
     * @param params Query parameters
     * @param params.sort Sort results. Default sorting is by tld ascending.
     */
    listTlds: {
        (params?: QueryParams & {
            sort?: "tld:asc" | "tld:desc";
        }): Promise<{
            data: Array<types.TLD>;
            pagination: types.Pagination;
        }>;
        iterateAll(params?: QueryParams & {
            sort?: "tld:asc" | "tld:desc";
        }): AsyncGenerator<types.TLD, any, any>;
        collectAll(params?: QueryParams & {
            sort?: "tld:asc" | "tld:desc";
        }): Promise<types.TLD[]>;
    };
    /**
     * Retrieves the details of a TLD.
     *
     * GET /tlds/{tld}
     *
     * @see https://developer.dnsimple.com/v2/tlds/#getTld
     *
     * @param tld The TLD string
     * @param params Query parameters
     */
    getTld: (tld: string, params?: QueryParams & {}) => Promise<{
        data: types.TLD;
    }>;
    /**
     * Lists a TLD extended attributes.
     *
     * Some TLDs require extended attributes when registering or transferring a domain. This API interface provides information on the extended attributes for any particular TLD. Extended attributes are extra TLD-specific attributes, required by the TLD registry to collect extra information about the registrant or legal agreements.
     *
     * GET /tlds/{tld}/extended_attributes
     *
     * @see https://developer.dnsimple.com/v2/tlds/#getTldExtendedAttributes
     *
     * @param tld The TLD string
     * @param params Query parameters
     */
    getTldExtendedAttributes: (tld: string, params?: QueryParams & {}) => Promise<{
        data: Array<types.ExtendedAttribute>;
    }>;
}