namecheap-ts 1.0.2 → 1.0.4

package/README.md

@@ -2,21 +2,25 @@
 
 A TypeScript package that provides a simple and intuitive interface to interact with Namecheap API.
 
-- **Installation**: You can install the package using npm. Run the following command in your terminal:
+## Installation
+
+You can install the package using npm. Run the following command in your terminal:
 
 ```shell
 npm install namecheap-ts
 ```
 
-- **Usage**: You can use the package to perform various operations such as domain registration, DNS management, SSL certificate management, and more. Here's an example of how to use the package to check whether the domain name is available or not:
+## Usage
+
+You can use the package to perform various operations such as domain registration, DNS management, SSL certificate management, and more. Here's an example of how to use the package to check whether the domain name is available or not:
 
 ```typescript
 import Namecheap, { INamecheapConfig } from "namecheap-ts";
 const config: INamecheapConfig = {
-  ApiKey: "api-key",
-  ApiUser: "api-user",
-  UserName: "user-name",
-  ClientIp: "client-ip",
+  apiKey: "api-key",
+  apiUser: "api-user",
+  username: "user-name",
+  clientIp: "client-ip",
 };
 
 const api = new Namecheap(config, true);
@@ -24,14 +28,102 @@ const api = new Namecheap(config, true);
 const payload = { DomainList: "mezoishere.net" };
 const { data } = await api.call("namecheap.domains.check", payload);
 
-const isAvailabe = data[0].DomainCheckResult[0].$.Available;
+const isAvailabe = data.DomainCheckResult.$.Available;
 console.log(isAvailable);
 ```
 
-Remove the second parameter to use the API for production like below:
+## API
+
+The `Namecheap` class is the main entry point for interacting with the Namecheap API.
+
+#### `constructor(config: INamecheapConfig, sandbox?: boolean)`
+
+Create a new instance of the `Namecheap` class.
+
+```typescript
+const namecheap = new Namecheap(config, true);
+```
+
+#### `call(command: Command, payload: Payload): Promise<IReponse>`
+
+Call a command on the Namecheap API.
+
+```typescript
+import { Commands } from "namecheap-ts";
+const response = await namecheap.call(Commands.DOMAINS_CHECK, {
+  DomainList: "example.com",
+});
+
+console.log(response);
+```
+
+#### `checkDomain(domainName: string): Promise<ICheckDomainResponse>`
+
+Check if a domain is available and if it'is premium.
+
+```typescript
+const { data } = await namecheap.checkDomain("example.com");
+
+console.log({ availabe: data.availabe, premium: data.premium });
+```
+
+#### `getDomainPrice(domainName: string, action: DomainPriceAction): Promise<IReponse>`
+
+Get the prices list of a domain.
+
+```typescript
+import { DomainPriceAction } from "namecheap-ts";
+const response = await namecheap.getDomainPrice(
+  "example.com",
+  DomainPriceAction.REGISTER
+);
+
+console.log(response);
+```
+
+#### `registerDomain(payload: Payload): Promise<IRegisterDomainResponse>`
+
+Register domain in namecheap.
 
 ```typescript
-const api = new Namecheap(config);
+const payload = {
+  DomainName: "mezoishere.co",
+  Years: 2,
+  // ...etc other attributes
+};
+
+const response = await namecheap.registerDomain(payload);
+
+console.log(response);
+```
+
+#### `addFundsRequest(payload: AddFundsRequestPayload): Promise<IAddFundsRequestResponse>`
+
+Add funds to the user account.
+
+```typescript
+const payload = {
+  username: "username",
+  paymentType: "creditcard",
+  amount: 10,
+  returnURL: "the return url after payment is done",
+};
+
+const response = await namecheap.addFundsRequest(payload);
+
+console.log(response);
+```
+
+#### `getFundsStatus(tokenId: string): Promise<IGetFundsStatusResponse>`
+
+Check the status of a specific funds request.
+
+```typescript
+const tokenId = "the-token-id-of-the-created-funds-request"
+
+const response = await namecheap.getFundsStatus(tokentId);
+
+console.log(response);
 ```
 
 You can refer to the official Namecheap API documentation for more information on the available methods and parameters. [The documentation is available at ¹](https://www.namecheap.com/support/api/intro/).

package/dist/index.d.mts

@@ -1,21 +1,125 @@
-declare const COMMANDS: readonly ["namecheap.domains.getList", "namecheap.domains.getContacts", "namecheap.domains.create", "namecheap.domains.getTldList", "namecheap.domains.setContacts", "namecheap.domains.check", "namecheap.domains.reactivate", "namecheap.domains.renew", "namecheap.domains.getRegistrarLock", "namecheap.domains.setRegistrarLock", "namecheap.domains.getInfo", "namecheap.domains.dns.setDefault", "namecheap.domains.dns.setCustom", "namecheap.domains.dns.getList", "namecheap.domains.dns.getHosts", "namecheap.domains.dns.getEmailForwarding", "namecheap.domains.dns.setEmailForwarding", "namecheap.domains.dns.setHosts", "namecheap.domains.ns.create", "namecheap.domains.ns.delete", "namecheap.domains.ns.getInfo", "namecheap.domains.ns.update", "namecheap.domains.transfer.create", "namecheap.domains.transfer.getStatus", "namecheap.domains.transfer.updateStatus", "namecheap.domains.transfer.getList", "namecheap.ssl.create", "namecheap.ssl.getList", "namecheap.ssl.parseCSR", "namecheap.ssl.getApproverEmailList", "namecheap.ssl.activate", "namecheap.ssl.resendApproverEmail", "namecheap.ssl.getInfo", "namecheap.ssl.renew", "namecheap.ssl.reissue", "namecheap.ssl.resendfulfillmentemail", "namecheap.ssl.purchasemoresans", "namecheap.ssl.revokecertificate", "namecheap.ssl.editDCVMethod", "namecheap.users.getPricing", "namecheap.users.getBalances", "namecheap.users.changePassword", "namecheap.users.update", "namecheap.users.createaddfundsrequest", "namecheap.users.getAddFundsStatus", "namecheap.users.create", "namecheap.users.login", "namecheap.users.resetPassword", "namecheap.users.address.create", "namecheap.users.address.delete", "namecheap.users.address.getInfo", "namecheap.users.address.getList", "namecheap.users.address.setDefault", "namecheap.users.address.update", "Namecheap.Whoisguard.changeemailaddress", "Namecheap.Whoisguard.enable", "Namecheap.Whoisguard.disable", "Namecheap.Whoisguard.getList", "Namecheap.Whoisguard.renew"];
-type ICommand = (typeof COMMANDS)[number];
-
-interface INamecheapConfig {
-    ApiUser: string;
-    ApiKey: string;
-    UserName: string;
-    ClientIp: string;
+declare enum Commands {
+    DOMAINS_GETLIST = "namecheap.domains.getList",
+    DOMAINS_GETCONTACTS = "namecheap.domains.getContacts",
+    DOMAINS_CREATE = "namecheap.domains.create",
+    DOMAINS_GETTLDLIST = "namecheap.domains.getTldList",
+    DOMAINS_SETCONTACTS = "namecheap.domains.setContacts",
+    DOMAINS_CHECK = "namecheap.domains.check",
+    DOMAINS_REACTIVATE = "namecheap.domains.reactivate",
+    DOMAINS_RENEW = "namecheap.domains.renew",
+    DOMAINS_GETREGISTRARLOCK = "namecheap.domains.getRegistrarLock",
+    DOMAINS_SETREGISTRARLOCK = "namecheap.domains.setRegistrarLock",
+    DOMAINS_GETINFO = "namecheap.domains.getInfo",
+    DOMAINS_DNS_SETDEFAULT = "namecheap.domains.dns.setDefault",
+    DOMAINS_DNS_SETCUSTOM = "namecheap.domains.dns.setCustom",
+    DOMAINS_DNS_GETLIST = "namecheap.domains.dns.getList",
+    DOMAINS_DNS_GETHOSTS = "namecheap.domains.dns.getHosts",
+    DOMAINS_DNS_GETEMAILFORWARDING = "namecheap.domains.dns.getEmailForwarding",
+    DOMAINS_DNS_SETEMAILFORWARDING = "namecheap.domains.dns.setEmailForwarding",
+    DOMAINS_DNS_SETHOSTS = "namecheap.domains.dns.setHosts",
+    DOMAINS_NS_CREATE = "namecheap.domains.ns.create",
+    DOMAINS_NS_DELETE = "namecheap.domains.ns.delete",
+    DOMAINS_NS_GETINFO = "namecheap.domains.ns.getInfo",
+    DOMAINS_NS_UPDATE = "namecheap.domains.ns.update",
+    DOMAINS_TRANSFER_CREATE = "namecheap.domains.transfer.create",
+    DOMAINS_TRANSFER_GETSTATUS = "namecheap.domains.transfer.getStatus",
+    DOMAINS_TRANSFER_UPDATESTATUS = "namecheap.domains.transfer.updateStatus",
+    DOMAINS_TRANSFER_GETLIST = "namecheap.domains.transfer.getList",
+    SSL_CREATE = "namecheap.ssl.create",
+    SSL_GETLIST = "namecheap.ssl.getList",
+    SSL_PARSECSR = "namecheap.ssl.parseCSR",
+    SSL_GETAPPROVEREMAILLIST = "namecheap.ssl.getApproverEmailList",
+    SSL_ACTIVATE = "namecheap.ssl.activate",
+    SSL_RESENDAPPROVEREMAIL = "namecheap.ssl.resendApproverEmail",
+    SSL_GETINFO = "namecheap.ssl.getInfo",
+    SSL_RENEW = "namecheap.ssl.renew",
+    SSL_REISSUE = "namecheap.ssl.reissue",
+    SSL_RESENDFULFILLMENTEMAIL = "namecheap.ssl.resendfulfillmentemail",
+    SSL_PURCHASEMORESANS = "namecheap.ssl.purchasemoresans",
+    SSL_REVOKECERTIFICATE = "namecheap.ssl.revokecertificate",
+    SSL_EDITDCVMETHOD = "namecheap.ssl.editDCVMethod",
+    USERS_GETPRICING = "namecheap.users.getPricing",
+    USERS_GETBALANCES = "namecheap.users.getBalances",
+    USERS_CHANGEPASSWORD = "namecheap.users.changePassword",
+    USERS_UPDATE = "namecheap.users.update",
+    USERS_CREATEADDFUNDSREQUEST = "namecheap.users.createaddfundsrequest",
+    USERS_GETADDFUNDSSTATUS = "namecheap.users.getAddFundsStatus",
+    USERS_CREATE = "namecheap.users.create",
+    USERS_LOGIN = "namecheap.users.login",
+    USERS_RESETPASSWORD = "namecheap.users.resetPassword",
+    USERS_ADDRESS_CREATE = "namecheap.users.address.create",
+    USERS_ADDRESS_DELETE = "namecheap.users.address.delete",
+    USERS_ADDRESS_GETINFO = "namecheap.users.address.getInfo",
+    USERS_ADDRESS_GETLIST = "namecheap.users.address.getList",
+    USERS_ADDRESS_SETDEFAULT = "namecheap.users.address.setDefault",
+    USERS_ADDRESS_UPDATE = "namecheap.users.address.update",
+    WHOISGUARD_CHANGEEMAILADDRESS = "Namecheap.Whoisguard.changeemailaddress",
+    WHOISGUARD_ENABLE = "Namecheap.Whoisguard.enable",
+    WHOISGUARD_DISABLE = "Namecheap.Whoisguard.disable",
+    WHOISGUARD_GETLIST = "Namecheap.Whoisguard.getList",
+    WHOISGUARD_RENEW = "Namecheap.Whoisguard.renew"
 }
-interface ICallReponse {
-    data: any;
+type Command = `${Commands}`;
+
+type Payload = Record<string, string | number>;
+interface IReponse<T = any> {
+    data: T;
     status: number;
 }
+type ICheckDomainResponse = IReponse<{
+    availabe: boolean;
+    premium: boolean;
+}>;
+type IRegisterDomainResponse = IReponse<{
+    domain: string;
+    registered: boolean;
+    chargedAmount: number;
+    domainID: string;
+    orderID: string;
+    transactionID: string;
+    whoisguardEnable: boolean;
+    freePositiveSSL: boolean;
+    nonRealTimeDomain: boolean;
+}>;
+type IAddFundsRequestResponse = IReponse<{
+    tokenId: string;
+    returnURL: string;
+    redirectURL: string;
+}>;
+type IGetFundsStatusResponse = IReponse<{
+    status: string;
+    amount: number;
+}>;
+declare enum DomainPriceActions {
+    REGISTER = "REGISTER",
+    RENEW = "RENEW",
+    REACTIVATE = "REACTIVATE",
+    TRANSFER = "TRANSFER"
+}
+type DomainPriceAction = `${DomainPriceActions}`;
+type AddFundsRequestPayload = {
+    username: string;
+    paymentType: "creditcard";
+    amount: number;
+    returnURL: string;
+};
+
+interface INamecheapConfig {
+    apiUser: string;
+    apiKey: string;
+    username: string;
+    clientIp: string;
+}
 declare class Namecheap {
     private readonly config;
     private readonly apiClient;
     constructor(config: INamecheapConfig, sandbox?: boolean);
-    call(command: ICommand, payload: Record<string, string>): Promise<ICallReponse>;
+    call(command: Command, payload: Payload): Promise<IReponse>;
+    checkDomain(domainName: string): Promise<ICheckDomainResponse>;
+    getDomainPrice(domainName: string, action: DomainPriceAction): Promise<IReponse<object[]>>;
+    registerDomain(payload: Payload): Promise<IRegisterDomainResponse>;
+    addFundsRequest(payload: AddFundsRequestPayload): Promise<IAddFundsRequestResponse>;
+    getFundsStatus(tokenId: string): Promise<IGetFundsStatusResponse>;
 }
 
-export { ICallReponse, INamecheapConfig, Namecheap as default };
+export { AddFundsRequestPayload, Command, Commands, DomainPriceAction, DomainPriceActions, IAddFundsRequestResponse, ICheckDomainResponse, IGetFundsStatusResponse, INamecheapConfig, IRegisterDomainResponse, IReponse, Payload, Namecheap as default };

package/dist/index.d.ts

@@ -1,2 +1,125 @@
-export * from "./namecheap";
-export { default } from "./namecheap";
+declare enum Commands {
+    DOMAINS_GETLIST = "namecheap.domains.getList",
+    DOMAINS_GETCONTACTS = "namecheap.domains.getContacts",
+    DOMAINS_CREATE = "namecheap.domains.create",
+    DOMAINS_GETTLDLIST = "namecheap.domains.getTldList",
+    DOMAINS_SETCONTACTS = "namecheap.domains.setContacts",
+    DOMAINS_CHECK = "namecheap.domains.check",
+    DOMAINS_REACTIVATE = "namecheap.domains.reactivate",
+    DOMAINS_RENEW = "namecheap.domains.renew",
+    DOMAINS_GETREGISTRARLOCK = "namecheap.domains.getRegistrarLock",
+    DOMAINS_SETREGISTRARLOCK = "namecheap.domains.setRegistrarLock",
+    DOMAINS_GETINFO = "namecheap.domains.getInfo",
+    DOMAINS_DNS_SETDEFAULT = "namecheap.domains.dns.setDefault",
+    DOMAINS_DNS_SETCUSTOM = "namecheap.domains.dns.setCustom",
+    DOMAINS_DNS_GETLIST = "namecheap.domains.dns.getList",
+    DOMAINS_DNS_GETHOSTS = "namecheap.domains.dns.getHosts",
+    DOMAINS_DNS_GETEMAILFORWARDING = "namecheap.domains.dns.getEmailForwarding",
+    DOMAINS_DNS_SETEMAILFORWARDING = "namecheap.domains.dns.setEmailForwarding",
+    DOMAINS_DNS_SETHOSTS = "namecheap.domains.dns.setHosts",
+    DOMAINS_NS_CREATE = "namecheap.domains.ns.create",
+    DOMAINS_NS_DELETE = "namecheap.domains.ns.delete",
+    DOMAINS_NS_GETINFO = "namecheap.domains.ns.getInfo",
+    DOMAINS_NS_UPDATE = "namecheap.domains.ns.update",
+    DOMAINS_TRANSFER_CREATE = "namecheap.domains.transfer.create",
+    DOMAINS_TRANSFER_GETSTATUS = "namecheap.domains.transfer.getStatus",
+    DOMAINS_TRANSFER_UPDATESTATUS = "namecheap.domains.transfer.updateStatus",
+    DOMAINS_TRANSFER_GETLIST = "namecheap.domains.transfer.getList",
+    SSL_CREATE = "namecheap.ssl.create",
+    SSL_GETLIST = "namecheap.ssl.getList",
+    SSL_PARSECSR = "namecheap.ssl.parseCSR",
+    SSL_GETAPPROVEREMAILLIST = "namecheap.ssl.getApproverEmailList",
+    SSL_ACTIVATE = "namecheap.ssl.activate",
+    SSL_RESENDAPPROVEREMAIL = "namecheap.ssl.resendApproverEmail",
+    SSL_GETINFO = "namecheap.ssl.getInfo",
+    SSL_RENEW = "namecheap.ssl.renew",
+    SSL_REISSUE = "namecheap.ssl.reissue",
+    SSL_RESENDFULFILLMENTEMAIL = "namecheap.ssl.resendfulfillmentemail",
+    SSL_PURCHASEMORESANS = "namecheap.ssl.purchasemoresans",
+    SSL_REVOKECERTIFICATE = "namecheap.ssl.revokecertificate",
+    SSL_EDITDCVMETHOD = "namecheap.ssl.editDCVMethod",
+    USERS_GETPRICING = "namecheap.users.getPricing",
+    USERS_GETBALANCES = "namecheap.users.getBalances",
+    USERS_CHANGEPASSWORD = "namecheap.users.changePassword",
+    USERS_UPDATE = "namecheap.users.update",
+    USERS_CREATEADDFUNDSREQUEST = "namecheap.users.createaddfundsrequest",
+    USERS_GETADDFUNDSSTATUS = "namecheap.users.getAddFundsStatus",
+    USERS_CREATE = "namecheap.users.create",
+    USERS_LOGIN = "namecheap.users.login",
+    USERS_RESETPASSWORD = "namecheap.users.resetPassword",
+    USERS_ADDRESS_CREATE = "namecheap.users.address.create",
+    USERS_ADDRESS_DELETE = "namecheap.users.address.delete",
+    USERS_ADDRESS_GETINFO = "namecheap.users.address.getInfo",
+    USERS_ADDRESS_GETLIST = "namecheap.users.address.getList",
+    USERS_ADDRESS_SETDEFAULT = "namecheap.users.address.setDefault",
+    USERS_ADDRESS_UPDATE = "namecheap.users.address.update",
+    WHOISGUARD_CHANGEEMAILADDRESS = "Namecheap.Whoisguard.changeemailaddress",
+    WHOISGUARD_ENABLE = "Namecheap.Whoisguard.enable",
+    WHOISGUARD_DISABLE = "Namecheap.Whoisguard.disable",
+    WHOISGUARD_GETLIST = "Namecheap.Whoisguard.getList",
+    WHOISGUARD_RENEW = "Namecheap.Whoisguard.renew"
+}
+type Command = `${Commands}`;
+
+type Payload = Record<string, string | number>;
+interface IReponse<T = any> {
+    data: T;
+    status: number;
+}
+type ICheckDomainResponse = IReponse<{
+    availabe: boolean;
+    premium: boolean;
+}>;
+type IRegisterDomainResponse = IReponse<{
+    domain: string;
+    registered: boolean;
+    chargedAmount: number;
+    domainID: string;
+    orderID: string;
+    transactionID: string;
+    whoisguardEnable: boolean;
+    freePositiveSSL: boolean;
+    nonRealTimeDomain: boolean;
+}>;
+type IAddFundsRequestResponse = IReponse<{
+    tokenId: string;
+    returnURL: string;
+    redirectURL: string;
+}>;
+type IGetFundsStatusResponse = IReponse<{
+    status: string;
+    amount: number;
+}>;
+declare enum DomainPriceActions {
+    REGISTER = "REGISTER",
+    RENEW = "RENEW",
+    REACTIVATE = "REACTIVATE",
+    TRANSFER = "TRANSFER"
+}
+type DomainPriceAction = `${DomainPriceActions}`;
+type AddFundsRequestPayload = {
+    username: string;
+    paymentType: "creditcard";
+    amount: number;
+    returnURL: string;
+};
+
+interface INamecheapConfig {
+    apiUser: string;
+    apiKey: string;
+    username: string;
+    clientIp: string;
+}
+declare class Namecheap {
+    private readonly config;
+    private readonly apiClient;
+    constructor(config: INamecheapConfig, sandbox?: boolean);
+    call(command: Command, payload: Payload): Promise<IReponse>;
+    checkDomain(domainName: string): Promise<ICheckDomainResponse>;
+    getDomainPrice(domainName: string, action: DomainPriceAction): Promise<IReponse<object[]>>;
+    registerDomain(payload: Payload): Promise<IRegisterDomainResponse>;
+    addFundsRequest(payload: AddFundsRequestPayload): Promise<IAddFundsRequestResponse>;
+    getFundsStatus(tokenId: string): Promise<IGetFundsStatusResponse>;
+}
+
+export { AddFundsRequestPayload, Command, Commands, DomainPriceAction, DomainPriceActions, IAddFundsRequestResponse, ICheckDomainResponse, IGetFundsStatusResponse, INamecheapConfig, IRegisterDomainResponse, IReponse, Payload, Namecheap as default };