@fwgapps/namecheap 0.4.1 → 0.6.0

package/dist/index.d.cts

@@ -14,7 +14,7 @@ interface NamecheapProps {
 }
 
 interface Paging {
-    totalItem: number;
+    totalItems: number;
     currentPage: number;
     pageSize: number;
     paging: boolean;
@@ -40,22 +40,22 @@ interface Contacts {
     auxBilling: ContactDetail;
 }
 interface ContactDetail {
-    organizationName: string;
-    jobTitle: string;
+    organizationName?: string;
+    jobTitle?: string;
     firstName: string;
     lastName: string;
     address1: string;
-    address2: string;
+    address2?: string;
     city: string;
     stateProvince: string;
-    stateProvinceChoice: string;
-    postalCode: number;
+    stateProvinceChoice?: string;
+    postalCode: string | number;
     country: string;
-    phone: number;
-    fax: number;
+    phone: string | number;
+    fax?: number;
     emailAddress: string;
-    phoneExt: number;
-    readOnly: boolean;
+    phoneExt?: number;
+    readOnly?: boolean;
 }
 interface CurrentAttributes {
     registrantNexus: string;
@@ -73,9 +73,9 @@ interface DomainCreateResult {
     domain: string;
     registered: boolean;
     chargedAmount: number;
-    domainID: number;
-    orderID: number;
-    transactionID: number;
+    domainId: number;
+    orderId: number;
+    transactionId: number;
     whoisguardEnable: boolean;
     nonRealTimeDomain: boolean;
 }
@@ -84,15 +84,16 @@ interface Category {
     sequenceNumber: number;
 }
 interface TLD {
+    value: string;
     name: string;
     nonRealTime: boolean;
     minRegisterYears: number;
     maxRegisterYears: number;
     minRenewYears: number;
     maxRenewYears: number;
-    renewalMinDays: number;
-    renewalMaxDays: number;
-    reactivateMaxDays: number;
+    renewalMinDays?: number;
+    renewalMaxDays?: number;
+    reactivateMaxDays?: number;
     minTransferYears: number;
     maxTransferYears: number;
     isApiRegisterable: boolean;
@@ -100,21 +101,21 @@ interface TLD {
     isApiTransferable: boolean;
     isEppRequired: boolean;
     isDisableModContact: boolean;
-    isDisableWGAllot: boolean;
+    isDisableWgAllot: boolean;
     isIncludeInExtendedSearchOnly: boolean;
     sequenceNumber: number;
     type: string;
-    subType: string;
-    isSupportsIDN: boolean;
+    subType?: string;
+    isSupportsIdn: boolean;
     category: string;
-    supportsRegistrarLock: boolean;
-    addGracePeriodDays: number;
-    whoisVerification: boolean;
-    providerApiDelete: boolean;
-    tldState: string;
-    searchGroup: string;
-    registry: string;
-    categories: Array<Category>;
+    supportsRegistrarLock?: boolean;
+    addGracePeriodDays?: number;
+    whoisVerification?: boolean;
+    providerApiDelete?: boolean;
+    tldState?: string;
+    searchGroup?: string;
+    registry?: string;
+    categories?: Array<Category>;
 }
 interface DomainCheckResult {
     domain: string;
@@ -151,31 +152,23 @@ interface DomainRenewResult {
 interface DomainGetRegistrarLockResult {
     domain: string;
     registrarLockStatus: boolean;
-    isClientUpdateProhibited: boolean;
-    isClientDeleteProhibited: boolean;
-    isClientHold: boolean;
-}
-interface DomainSetRegistrarLockResult {
-    domain: string;
-    isSuccess: boolean;
-    registrarLockStatus: boolean;
-    isRegistrarLockStatusUpdated: boolean;
-    isClientUpdateProhibitedUpdated: boolean;
-    isClientDeleteProhibitedUpdated: boolean;
-    isClientHoldUpdated: boolean;
+    isClientUpdateProhibited?: boolean;
+    isClientDeleteProhibited?: boolean;
+    isClientHold?: boolean;
 }
 interface DomainGetInfoResult {
     domainDetails: {
         createdDate: string;
         expiredDate: string;
-        numYears: number;
+        numYears?: number;
         domainDetails: boolean;
     };
     whoisguard: {
         id: number;
+        expiredDate: string;
         enabled: string;
     };
-    premiumDnsSubscription: {
+    premiumDnsSubscription?: {
         useAutoRenew: boolean;
         subscriptionId: number;
         createdDate: string;
@@ -184,13 +177,13 @@ interface DomainGetInfoResult {
         premiumDnsSubscription: boolean;
     };
     dnsDetails: {
-        nameserver: Array<string>;
+        nameserver?: Array<string>;
         providerType: string;
-        isUsingOurDns: boolean;
-        hostCount: number;
-        emailType: string;
-        dynamicDnsStatus: boolean;
-        isFailover: boolean;
+        isUsingOurDns?: boolean;
+        hostCount?: number;
+        emailType?: string;
+        dynamicDnsStatus?: boolean;
+        isFailover?: boolean;
     };
     modificationrights: {
         all: boolean;
@@ -485,17 +478,17 @@ interface CreateDomainParams extends Contacts {
     promoCode?: string;
     billing?: Partial<ContactDetail>;
     idnCode?: IdnCode;
-    extendedAttributes: string;
+    extendedAttributes?: string;
     nameservers?: string;
     addFreeWhoisguard?: string;
     WGEnabled?: string;
     isPremiumDomain?: boolean;
     premiumPrice?: number;
-    eapPrice?: number;
+    eapFee?: number;
 }
 interface ContactDomainParams extends Contacts {
     domainName: string;
-    extendedAttributes: string;
+    extendedAttributes?: string;
 }
 interface ReactivateDomainParams {
     domainName: string;
@@ -511,27 +504,64 @@ interface RenewDomainParams {
     isPremiumDomain?: boolean;
     premiumPrice?: number;
 }
-interface SetRegistrarLockParams {
-    domainName: string;
-    lockAction: LockAction;
-}
 
 declare class Domains {
     private readonly config;
     constructor(config: NamecheapProps);
+    /**
+     * Returns a list of domains for the particular user
+     * @note IMPORTANT: Namecheap API privacy service provider recently changed to WithheldforPrivacy. We want to avoid service interruption for namecheap API users, so please note that in some cases, you may still see Whoisguard in the API parameter names.
+     */
     getList(params?: GetListParams$1): Promise<{
         data: Array<DomainGetListResult>;
         paging: Paging;
     }>;
+    /**
+     * Gets contact information for the requested domain
+     * @note IMPORTANT: Namecheap API privacy service provider recently changed to WithheldforPrivacy. We want to avoid service interruption for our API users, so please note that in some cases, you may still see Whoisguard in the API parameter names.
+     */
     getContacts(domainName: string): Promise<DomainContactsResult>;
+    /**
+     * Registers a new domain
+     * @note IMPORTANT: Namecheap API privacy service provider recently changed to WithheldforPrivacy. We want to avoid service interruption for our API users, so please note that in some cases, you may still see Whoisguard in the API parameter names.
+     * @note For successful registration of an IDN domain, you need to send the IdnCode parameter and provide the domain name in the Punycode format (Example: xn--sdkhjsdhfkdh.com), as we do not support native code.
+     */
     create(domain: string, params: Omit<CreateDomainParams, "domainName">): Promise<DomainCreateResult>;
+    /**
+     * Returns a list of TLDs
+     * @note IMPORTANT: Namecheap API privacy service provider recently changed to WithheldforPrivacy. We want to avoid service interruption for our API users, so please note that in some cases, you may still see Whoisguard in the API parameter names.
+     * @note We strongly recommend that you cache this API response to avoid repeated calls.
+     *
+     */
     getTldList(): Promise<Array<TLD>>;
+    /**
+     * Sets contact information for the requested domain
+     */
     setContacts(domain: string, params: Omit<ContactDomainParams, "domainName">): Promise<string>;
-    check(domains: Array<string>): Promise<DomainCheckResult>;
+    /**
+     * Checks the availability of domains
+     */
+    check(domains: Array<string>): Promise<Array<DomainCheckResult>>;
+    /**
+     * Reactivates an expired domain
+     */
     reactivate(domain: string, params?: Omit<ReactivateDomainParams, "domainName">): Promise<DomainReactivateResult>;
+    /**
+     * Renews an expiring domain
+     */
     renew(domain: string, params: Omit<RenewDomainParams, "domainName">): Promise<DomainRenewResult>;
+    /**
+     * Gets the Registrar Lock status for the requested domain
+     */
     getRegistrarLock(domain: string): Promise<DomainGetRegistrarLockResult>;
-    setRegistrarLock(domain: string, params?: Omit<SetRegistrarLockParams, "domainName">): Promise<DomainSetRegistrarLockResult>;
+    /**
+     * Sets the Registrar Lock status for a domain
+     */
+    setRegistrarLock(domain: string, lockAction?: LockAction): Promise<string>;
+    /**
+     * Returns information about the requested domain
+     * @note IMPORTANT: Namecheap API privacy service provider recently changed to WithheldforPrivacy. We want to avoid service interruption for Namecheap API users, so please note that in some cases, you may still see Whoisguard in the API parameter names.
+     */
     getInfo(domain: string, hostName?: string): Promise<DomainGetInfoResult>;
 }
 
@@ -589,103 +619,37 @@ interface SetDNSHostsParams {
 
 declare class DomainsDNS {
     private readonly config;
-    /**
-     * @constructor initial configuration to use global settings
-     * @param {NamecheapProps} config Namecheap credentials
-     */
     constructor(config: NamecheapProps);
     /**
-     * Sets domain to use our default DNS servers.
+     * Sets domain to use namecheap api default DNS servers.
      * Required for free services like Host record management, URL forwarding, email forwarding, dynamic dns and other value added services.
-     * @param {string} sld SLD of the DomainName
-     * @param {string} tld TLD of the DomainName
-     * @returns {Promise<>string>} Returns the domain name that you are trying to set default nameservers for.
      */
     setDefault(sld: string, tld: string): Promise<string>;
     /**
      * Sets domain to use custom DNS servers.
      * @note Services like URL forwarding, Email forwarding, Dynamic DNS will not work for domains using custom nameservers
-     * @param {string} sld SLD of the DomainName
-     * @param {string} tld TLD of the DomainName
-     * @param {Array<string>} nameservers A list of name servers to be associated with this domain
-     * @returns {Promise<string>} Returns the domain name that you are trying to set custom nameservers for.
      */
     setCustom(sld: string, tld: string, nameservers: Array<string>): Promise<string>;
     /**
      * Gets a list of DNS servers associated with the requested domain.
-     * @param {string} sld SLD of the DomainName
-     * @param {string} tld TLD of the DomainName
-     * @returns List of DNS info (see {@link DomainDnsGetListResult})
      */
     getList(sld: string, tld: string): Promise<DomainDnsGetListResult>;
     /**
      * Retrieves DNS host record settings for the requested domain.
-     * @param {string} sld SLD of the DomainName
-     * @param {string} tld TLD of the DomainName
-     * @returns DNS host records info (see {@link DomainDnsGetHostsResult})
      */
     getHosts(sld: string, tld: string): Promise<DomainDnsGetHostsResult>;
     /**
      * Gets email forwarding settings for the requested domain.
-     * @param {string} domain Domain name to get settings
-     * @returns Email forwarding info (see {@link DomainDnsGetEmailForwardingResult})
      */
     getEmailForwarding(domain: string): Promise<DomainDnsGetEmailForwardingResult>;
     /**
      * Sets email forwarding for a domain name.
-     * @param {string} domain Domain name to set settings
-     * @param {SetDNSEmailForwardingParams} params Set mailbox and forwards
-     * - mailBox: for which you wish to set email forwarding.
-     * - forwardTo: Email address to forward to
-     * @example
-     * setEmailForwarding("mydomain.com", {
-     *    mailBox: ["example@namecheap.com"],
-     *    forwardTo: ["example:example@gmail.com"]
-     *  })
-     *  @returns Return email affected
      */
     setEmailForwarding(domain: string, params: Omit<SetDNSEmailForwardingParams, "domainName">): Promise<string>;
     /**
      * Sets DNS host records settings for the requested domain.
      * @note If you set more than 10 hosts the request will be done by POST method otherwise by GET method.
      * @note All host records that are not included into the API call will be deleted, so add them in addition to new host records.
-     * @param {string} sld
-     * @param {string} tld
-     * @param {Omit<
-     *       SetDNSHostsParams,
-     *       "sld" | "tld" | "address" | "hostname" | "mxpref" | "recordType" | "ttl"
-     *     > & { hosts: Array<Host> }} params Host record configuration object:
-     *  - emailType?: The type of email service to use.
-     *    - MXE: to set up your custom MXE record.
-     *    - MX: to set up custom MX records of your mail provider.
-     *    - FWD: to set up MX records for our Free Email Forwarding service.
-     *    - OX: to set up MX records for our Private Email service.
-     *  - flag?: Is an unsigned integer between 0 and 255. The flag value is an 8-bit number, the most significant bit of which indicates the criticality of understanding of a record by a CA. It's recommended to use `0`
-     *  - tag?: A non-zero sequence of US-ASCII letters and numbers in lower case. The tag value can be one of the following values:
-     *    - issue — specifies the certification authority that is authorized to issue a certificate for the domain name or subdomain record used in the title.
-     *    - issuewild — specifies the certification authority that is allowed to issue a wildcard certificate for the domain name or subdomain record used in the title. The certificate applies to the domain name or subdomain directly and to all its subdomains.
-     *    - iodef — specifies the e-mail address or URL (compliant with RFC 5070) a CA should use to notify a client if any issuance policy violation spotted by this CA.
-     * - hosts: Array with host properties
-     *  - hostname: Sub-domain/hostname to create the record for
-     *  - recordType: Record type to that host, possible values
-     *    - A
-     *    - AAAA
-     *    - ALIAS
-     *    - CAA
-     *    - CNAME
-     *    - MX
-     *    - MXE
-     *    - NS
-     *    - TXT
-     *    - URL
-     *    - URL301
-     *    - FRAME
-     *  - address: The value for this parameter is based on RecordType. Possible values:
-     *    - URL
-     *    - IP address
-     *  - mxpref?: MX preference for host. Applicable for MX records only.
-     *  - ttl?: Time to live for all record types.
-     *  @returns Return host list affected
      */
     setHosts(sld: string, tld: string, params: Omit<SetDNSHostsParams, "sld" | "tld" | "address" | "hostname" | "mxpref" | "recordType" | "ttl"> & {
         hosts: Array<Host>;