@apteva/integrations 0.3.62 → 0.15.4

package/src/apps/namecheap.json

@@ -1,8 +1,8 @@
 {
   "slug": "namecheap",
   "name": "Namecheap",
-  "description": "Namecheap domain registrar - register domains, manage DNS, check availability, and handle domain contacts",
-  "logo": "https://www.google.com/s2/favicons?domain=namecheap.com&sz=128",
+  "description": "Namecheap domain registrar — register and manage domains, check availability, manage DNS host records, contacts, nameservers, and account balance. Uses the legacy XML/Query API; responses are auto-parsed from XML to JSON.",
+  "logo": "https://www.namecheap.com/assets/img/nc-icon/favicon.ico",
   "categories": [
     "dns",
     "domains",
@@ -12,251 +12,449 @@
   "base_url": "https://api.namecheap.com/xml.response",
   "auth": {
     "types": [
-      "bearer"
+      "api_key"
     ],
+    "query_params": {
+      "ApiUser": "{{api_user}}",
+      "ApiKey": "{{api_key}}",
+      "UserName": "{{username}}",
+      "ClientIp": "{{client_ip}}"
+    },
     "headers": {
-      "Authorization": "Bearer {{token}}"
+      "Content-Type": "application/x-www-form-urlencoded"
     },
     "credential_fields": [
       {
-        "name": "apiUser",
-        "label": "Api User",
-        "description": "Namecheap API username (usually your account username)"
-      },
-      {
-        "name": "token",
-        "label": "Api Key",
-        "description": "Namecheap API key (generate from Account > Profile > Tools > API Access)"
+        "name": "api_user",
+        "label": "API User",
+        "description": "Your Namecheap account username (used as the API user identifier)",
+        "required": true,
+        "type": "text"
       },
       {
-        "name": "userName",
-        "label": "User Name",
-        "description": "Namecheap account username"
+        "name": "api_key",
+        "label": "API Key",
+        "description": "API key generated at Namecheap → Profile → Tools → Business & Dev Tools → Manage Namecheap API Access",
+        "required": true,
+        "type": "password"
       },
       {
-        "name": "clientIp",
-        "label": "Client Ip",
-        "description": "Your whitelisted IP address (must be whitelisted in Namecheap account)"
+        "name": "username",
+        "label": "Username",
+        "description": "Namecheap account username on whose behalf the request is made (typically the same as API User)",
+        "required": true,
+        "type": "text"
       },
       {
-        "name": "mode",
-        "label": "Mode",
-        "description": "API mode: live or sandbox (default: live)"
-      },
-      {
-        "name": "apiKey",
-        "label": "Api Key",
-        "description": "Namecheap API key (generate from Account > Profile > Tools > API Access)"
+        "name": "client_ip",
+        "label": "Client IP",
+        "description": "IPv4 address making the request. MUST be whitelisted in your Namecheap API settings — non-whitelisted IPs return error code 1011102. Only IPv4 addresses are accepted.",
+        "required": true,
+        "type": "text"
       }
     ]
   },
   "tools": [
     {
       "name": "list_domains",
-      "description": "List all domains in your Namecheap account with pagination. Returns domain names, expiration dates, and status. Note: Namecheap returns XML responses.",
+      "description": "List domains in the account with optional filtering. Returns DomainGetListResult with paginated Domain entries (Name, Created, Expires, IsExpired, IsLocked, AutoRenew, WhoisGuard, IsPremium).",
       "method": "GET",
-      "path": "/list-domains",
+      "path": "/?Command=namecheap.domains.getList",
       "input_schema": {
         "type": "object",
         "properties": {
-          "page": {
+          "ListType": {
+            "type": "string",
+            "enum": ["ALL", "EXPIRING", "EXPIRED"],
+            "default": "ALL"
+          },
+          "SearchTerm": {
+            "type": "string",
+            "description": "Substring filter on domain name"
+          },
+          "Page": {
             "type": "integer",
-            "description": "Page number to return (default: 1)",
+            "description": "Page number (1-based)",
             "default": 1
           },
-          "pageSize": {
+          "PageSize": {
             "type": "integer",
-            "description": "Number of domains per page (default: 20, max: 100)",
+            "description": "Page size (10-100)",
             "default": 20
+          },
+          "SortBy": {
+            "type": "string",
+            "enum": ["NAME", "NAME_DESC", "EXPIREDATE", "EXPIREDATE_DESC", "CREATEDATE", "CREATEDATE_DESC"]
           }
         }
       }
     },
     {
       "name": "check_availability",
-      "description": "Check if one or more domain names are available for registration. Pass a comma-separated list of domains. Note: Namecheap returns XML responses.",
+      "description": "Check whether one or more domains are available for registration. DomainList is comma-separated and accepts up to 50 domains. Returns DomainCheckResult per domain with Available, IsPremiumName, PremiumRegistrationPrice, IcannFee.",
       "method": "GET",
-      "path": "/check-availability",
+      "path": "/?Command=namecheap.domains.check",
       "input_schema": {
         "type": "object",
         "properties": {
-          "domainList": {
+          "DomainList": {
             "type": "string",
-            "description": "Comma-separated list of domains to check (e.g. 'example.com,example.net,example.org')"
+            "description": "Comma-separated list of fully-qualified domain names (max 50), e.g. 'example.com,example.net,example.org'"
           }
         },
-        "required": [
-          "domainList"
-        ]
+        "required": ["DomainList"]
       }
     },
     {
       "name": "get_domain_info",
-      "description": "Get detailed information about a specific domain including status, dates, nameservers, and WHOIS guard status. Note: Namecheap returns XML responses.",
+      "description": "Get full details for a single domain: status, dates, nameservers, modification rights, premium info, WhoisGuard.",
       "method": "GET",
-      "path": "/get-domain-info",
+      "path": "/?Command=namecheap.domains.getInfo",
       "input_schema": {
         "type": "object",
         "properties": {
-          "domainName": {
+          "DomainName": {
             "type": "string",
-            "description": "The domain name to get info for (e.g. 'example.com')"
+            "description": "Fully-qualified domain name"
           }
         },
-        "required": [
-          "domainName"
-        ]
+        "required": ["DomainName"]
       }
     },
     {
       "name": "register_domain",
-      "description": "Register a new domain name. Requires domain name, years, and contact information fields passed in the request body. Note: Namecheap returns XML responses.",
+      "description": "Register a new domain. ⚠️ This SPENDS REAL MONEY against your account balance. Requires complete WHOIS contact data for Registrant, Tech, Admin, and AuxBilling (Namecheap requires all four; reuse the same contact for all if appropriate).",
       "method": "POST",
-      "path": "/register-domain",
+      "path": "/?Command=namecheap.domains.create",
       "input_schema": {
         "type": "object",
         "properties": {
-          "domainName": {
-            "type": "string",
-            "description": "The domain name to register (e.g. 'example.com')"
-          },
-          "years": {
+          "DomainName": { "type": "string" },
+          "Years": {
             "type": "integer",
-            "description": "Number of years to register for (1-10)",
+            "description": "Number of years (1-10)",
             "default": 1
-          }
+          },
+          "PromotionCode": { "type": "string" },
+          "Nameservers": {
+            "type": "string",
+            "description": "Comma-separated list of custom nameservers; omit to use Namecheap defaults"
+          },
+          "AddFreeWhoisguard": {
+            "type": "string",
+            "enum": ["yes", "no"],
+            "default": "yes"
+          },
+          "WGEnabled": {
+            "type": "string",
+            "enum": ["yes", "no"],
+            "default": "yes"
+          },
+          "RegistrantFirstName": { "type": "string" },
+          "RegistrantLastName": { "type": "string" },
+          "RegistrantAddress1": { "type": "string" },
+          "RegistrantCity": { "type": "string" },
+          "RegistrantStateProvince": { "type": "string" },
+          "RegistrantPostalCode": { "type": "string" },
+          "RegistrantCountry": {
+            "type": "string",
+            "description": "ISO 3166-1 alpha-2 country code"
+          },
+          "RegistrantPhone": {
+            "type": "string",
+            "description": "Format: +CC.NNNNNNNNNN (e.g. +1.5551234567)"
+          },
+          "RegistrantEmailAddress": { "type": "string" },
+          "TechFirstName": { "type": "string" },
+          "TechLastName": { "type": "string" },
+          "TechAddress1": { "type": "string" },
+          "TechCity": { "type": "string" },
+          "TechStateProvince": { "type": "string" },
+          "TechPostalCode": { "type": "string" },
+          "TechCountry": { "type": "string" },
+          "TechPhone": { "type": "string" },
+          "TechEmailAddress": { "type": "string" },
+          "AdminFirstName": { "type": "string" },
+          "AdminLastName": { "type": "string" },
+          "AdminAddress1": { "type": "string" },
+          "AdminCity": { "type": "string" },
+          "AdminStateProvince": { "type": "string" },
+          "AdminPostalCode": { "type": "string" },
+          "AdminCountry": { "type": "string" },
+          "AdminPhone": { "type": "string" },
+          "AdminEmailAddress": { "type": "string" },
+          "AuxBillingFirstName": { "type": "string" },
+          "AuxBillingLastName": { "type": "string" },
+          "AuxBillingAddress1": { "type": "string" },
+          "AuxBillingCity": { "type": "string" },
+          "AuxBillingStateProvince": { "type": "string" },
+          "AuxBillingPostalCode": { "type": "string" },
+          "AuxBillingCountry": { "type": "string" },
+          "AuxBillingPhone": { "type": "string" },
+          "AuxBillingEmailAddress": { "type": "string" }
         },
         "required": [
-          "domainName",
-          "years"
+          "DomainName",
+          "Years",
+          "RegistrantFirstName", "RegistrantLastName", "RegistrantAddress1",
+          "RegistrantCity", "RegistrantStateProvince", "RegistrantPostalCode",
+          "RegistrantCountry", "RegistrantPhone", "RegistrantEmailAddress",
+          "TechFirstName", "TechLastName", "TechAddress1",
+          "TechCity", "TechStateProvince", "TechPostalCode",
+          "TechCountry", "TechPhone", "TechEmailAddress",
+          "AdminFirstName", "AdminLastName", "AdminAddress1",
+          "AdminCity", "AdminStateProvince", "AdminPostalCode",
+          "AdminCountry", "AdminPhone", "AdminEmailAddress",
+          "AuxBillingFirstName", "AuxBillingLastName", "AuxBillingAddress1",
+          "AuxBillingCity", "AuxBillingStateProvince", "AuxBillingPostalCode",
+          "AuxBillingCountry", "AuxBillingPhone", "AuxBillingEmailAddress"
         ]
       }
     },
     {
       "name": "renew_domain",
-      "description": "Renew an existing domain registration for additional years. Note: Namecheap returns XML responses.",
+      "description": "Renew a domain for the specified number of years. ⚠️ Spends account balance.",
       "method": "POST",
-      "path": "/renew-domain",
+      "path": "/?Command=namecheap.domains.renew",
       "input_schema": {
         "type": "object",
         "properties": {
-          "domainName": {
-            "type": "string",
-            "description": "The domain name to renew (e.g. 'example.com')"
-          },
-          "years": {
-            "type": "integer",
-            "description": "Number of years to renew for (1-10)",
-            "default": 1
-          }
+          "DomainName": { "type": "string" },
+          "Years": { "type": "integer", "default": 1 },
+          "PromotionCode": { "type": "string" }
         },
-        "required": [
-          "domainName",
-          "years"
-        ]
+        "required": ["DomainName", "Years"]
+      }
+    },
+    {
+      "name": "reactivate_domain",
+      "description": "Reactivate an expired domain (within the redemption grace period). ⚠️ Spends account balance, redemption fees may apply.",
+      "method": "POST",
+      "path": "/?Command=namecheap.domains.reactivate",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "DomainName": { "type": "string" },
+          "PromotionCode": { "type": "string" },
+          "YearsToAdd": { "type": "integer" }
+        },
+        "required": ["DomainName"]
+      }
+    },
+    {
+      "name": "get_contacts",
+      "description": "Get the four WHOIS contact sets (Registrant, Tech, Admin, AuxBilling) currently associated with a domain.",
+      "method": "GET",
+      "path": "/?Command=namecheap.domains.getContacts",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "DomainName": { "type": "string" }
+        },
+        "required": ["DomainName"]
+      }
+    },
+    {
+      "name": "set_contacts",
+      "description": "Update the WHOIS contact sets for a domain. ⚠️ Replaces ALL four contact sets (Registrant, Tech, Admin, AuxBilling). Required fields per contact: FirstName, LastName, Address1, City, StateProvince, PostalCode, Country, Phone (format +CC.NNNNNNNNNN), EmailAddress.",
+      "method": "POST",
+      "path": "/?Command=namecheap.domains.setContacts",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "DomainName": { "type": "string" },
+          "RegistrantFirstName": { "type": "string" },
+          "RegistrantLastName": { "type": "string" },
+          "RegistrantAddress1": { "type": "string" },
+          "RegistrantCity": { "type": "string" },
+          "RegistrantStateProvince": { "type": "string" },
+          "RegistrantPostalCode": { "type": "string" },
+          "RegistrantCountry": { "type": "string" },
+          "RegistrantPhone": { "type": "string" },
+          "RegistrantEmailAddress": { "type": "string" },
+          "TechFirstName": { "type": "string" },
+          "TechLastName": { "type": "string" },
+          "TechAddress1": { "type": "string" },
+          "TechCity": { "type": "string" },
+          "TechStateProvince": { "type": "string" },
+          "TechPostalCode": { "type": "string" },
+          "TechCountry": { "type": "string" },
+          "TechPhone": { "type": "string" },
+          "TechEmailAddress": { "type": "string" },
+          "AdminFirstName": { "type": "string" },
+          "AdminLastName": { "type": "string" },
+          "AdminAddress1": { "type": "string" },
+          "AdminCity": { "type": "string" },
+          "AdminStateProvince": { "type": "string" },
+          "AdminPostalCode": { "type": "string" },
+          "AdminCountry": { "type": "string" },
+          "AdminPhone": { "type": "string" },
+          "AdminEmailAddress": { "type": "string" },
+          "AuxBillingFirstName": { "type": "string" },
+          "AuxBillingLastName": { "type": "string" },
+          "AuxBillingAddress1": { "type": "string" },
+          "AuxBillingCity": { "type": "string" },
+          "AuxBillingStateProvince": { "type": "string" },
+          "AuxBillingPostalCode": { "type": "string" },
+          "AuxBillingCountry": { "type": "string" },
+          "AuxBillingPhone": { "type": "string" },
+          "AuxBillingEmailAddress": { "type": "string" }
+        },
+        "required": ["DomainName"]
+      }
+    },
+    {
+      "name": "get_tld_list",
+      "description": "List every TLD Namecheap supports for registration along with metadata: type, category, IsApiRegisterable/Renewable/Transferable, MinRegisterYears, MaxRegisterYears, etc.",
+      "method": "GET",
+      "path": "/?Command=namecheap.domains.getTldList",
+      "input_schema": {
+        "type": "object",
+        "properties": {}
       }
     },
     {
       "name": "get_dns_hosts",
-      "description": "Retrieve all DNS host records for a domain. Requires the second-level domain (SLD) and top-level domain (TLD) as separate parameters. Note: Namecheap returns XML responses.",
+      "description": "Get all DNS host records for a domain that uses Namecheap DNS. SLD = second-level (e.g. 'example'), TLD = top-level (e.g. 'com'). Returns DomainDNSGetHostsResult with host entries (HostId, Name, Type, Address, MXPref, TTL).",
       "method": "GET",
-      "path": "/get-dns-hosts",
+      "path": "/?Command=namecheap.domains.dns.getHosts",
       "input_schema": {
         "type": "object",
         "properties": {
-          "sld": {
+          "SLD": {
             "type": "string",
-            "description": "Second-level domain (e.g. 'example' from 'example.com')"
+            "description": "Second-level domain (the part before the dot, e.g. 'example' for example.com)"
           },
-          "tld": {
+          "TLD": {
             "type": "string",
-            "description": "Top-level domain (e.g. 'com' from 'example.com')"
+            "description": "Top-level domain (the part after the dot, e.g. 'com'). For multi-part TLDs like co.uk, pass 'co.uk'."
           }
         },
-        "required": [
-          "sld",
-          "tld"
-        ]
+        "required": ["SLD", "TLD"]
       }
     },
     {
       "name": "set_dns_hosts",
-      "description": "Set DNS host records for a domain. Replaces all existing records. Pass host record fields (HostName1, RecordType1, Address1, etc.) in the request body. Note: Namecheap returns XML responses.",
+      "description": "⚠️ DESTRUCTIVE OVERWRITE: this call replaces ALL DNS host records for the domain with exactly the set you supply — anything you omit is DELETED. Safe pattern: call get_dns_hosts first, merge in your changes, then send back the FULL list. Records are numbered: HostName1/RecordType1/Address1/MXPref1/TTL1, HostName2/..., up to as many as needed. Use POST (the URL-encoded body easily fits 50+ records).",
       "method": "POST",
-      "path": "/set-dns-hosts",
+      "path": "/?Command=namecheap.domains.dns.setHosts",
       "input_schema": {
         "type": "object",
         "properties": {
-          "sld": {
-            "type": "string",
-            "description": "Second-level domain (e.g. 'example' from 'example.com')"
-          },
-          "tld": {
+          "SLD": { "type": "string" },
+          "TLD": { "type": "string" },
+          "HostName1": { "type": "string", "description": "Host record name (subdomain only, '@' for apex)" },
+          "RecordType1": { "type": "string", "enum": ["A", "AAAA", "CNAME", "MX", "MXE", "TXT", "URL", "URL301", "FRAME", "NS", "CAA", "ALIAS"] },
+          "Address1": { "type": "string", "description": "Record value" },
+          "MXPref1": { "type": "string", "description": "MX preference (required for MX records)" },
+          "TTL1": { "type": "string", "default": "1800" },
+          "HostName2": { "type": "string" },
+          "RecordType2": { "type": "string" },
+          "Address2": { "type": "string" },
+          "MXPref2": { "type": "string" },
+          "TTL2": { "type": "string" },
+          "HostName3": { "type": "string" },
+          "RecordType3": { "type": "string" },
+          "Address3": { "type": "string" },
+          "MXPref3": { "type": "string" },
+          "TTL3": { "type": "string" },
+          "HostName4": { "type": "string" },
+          "RecordType4": { "type": "string" },
+          "Address4": { "type": "string" },
+          "MXPref4": { "type": "string" },
+          "TTL4": { "type": "string" },
+          "HostName5": { "type": "string" },
+          "RecordType5": { "type": "string" },
+          "Address5": { "type": "string" },
+          "MXPref5": { "type": "string" },
+          "TTL5": { "type": "string" }
+        },
+        "required": ["SLD", "TLD"]
+      }
+    },
+    {
+      "name": "set_dns_default",
+      "description": "Reset a domain's nameservers to Namecheap's default DNS (registrar-default DNS). Use this to switch back from custom DNS to Namecheap-hosted DNS.",
+      "method": "POST",
+      "path": "/?Command=namecheap.domains.dns.setDefault",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "SLD": { "type": "string" },
+          "TLD": { "type": "string" }
+        },
+        "required": ["SLD", "TLD"]
+      }
+    },
+    {
+      "name": "set_dns_custom",
+      "description": "Set custom external nameservers for a domain (1-13 nameservers, comma-separated). Once set, DNS hosts must be managed at the external provider — Namecheap's host-record API stops applying.",
+      "method": "POST",
+      "path": "/?Command=namecheap.domains.dns.setCustom",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "SLD": { "type": "string" },
+          "TLD": { "type": "string" },
+          "Nameservers": {
             "type": "string",
-            "description": "Top-level domain (e.g. 'com' from 'example.com')"
+            "description": "Comma-separated nameserver hostnames (e.g. 'ns1.cloudflare.com,ns2.cloudflare.com')"
           }
         },
-        "required": [
-          "sld",
-          "tld"
-        ]
+        "required": ["SLD", "TLD", "Nameservers"]
       }
     },
     {
-      "name": "get_contacts",
-      "description": "Retrieve the contact information (registrant, tech, admin, aux billing) for a domain. Note: Namecheap returns XML responses.",
+      "name": "get_nameservers",
+      "description": "Get the nameservers currently set on a domain (whether default Namecheap or custom).",
       "method": "GET",
-      "path": "/get-contacts",
+      "path": "/?Command=namecheap.domains.dns.getList",
       "input_schema": {
         "type": "object",
         "properties": {
-          "domainName": {
-            "type": "string",
-            "description": "The domain name to get contacts for (e.g. 'example.com')"
-          }
+          "SLD": { "type": "string" },
+          "TLD": { "type": "string" }
         },
-        "required": [
-          "domainName"
-        ]
+        "required": ["SLD", "TLD"]
       }
     },
     {
-      "name": "get_tld_list",
-      "description": "Get pricing information for all available TLDs including registration, renewal, and transfer prices. Note: Namecheap returns XML responses.",
+      "name": "get_balance",
+      "description": "Get the current account balance — AvailableBalance (spendable), AccountBalance (total including funds in transit), EarnedAmount, WithdrawableAmount.",
       "method": "GET",
-      "path": "/get-tld-list",
+      "path": "/?Command=namecheap.users.getBalances",
       "input_schema": {
         "type": "object",
         "properties": {}
       }
     },
     {
-      "name": "set_nameservers",
-      "description": "Set custom nameservers for a domain. Provide the nameservers as a comma-separated string. Note: Namecheap returns XML responses.",
-      "method": "POST",
-      "path": "/set-nameservers",
+      "name": "get_pricing",
+      "description": "Look up retail pricing for a product type (DOMAIN, SSLCERTIFICATE, WHOISGUARD). For domains, optionally filter by category (REGISTER, RENEW, TRANSFER) and a specific TLD.",
+      "method": "GET",
+      "path": "/?Command=namecheap.users.getPricing",
       "input_schema": {
         "type": "object",
         "properties": {
-          "sld": {
+          "ProductType": {
+            "type": "string",
+            "enum": ["DOMAIN", "SSLCERTIFICATE", "WHOISGUARD"]
+          },
+          "ProductCategory": {
             "type": "string",
-            "description": "Second-level domain (e.g. 'example' from 'example.com')"
+            "enum": ["REGISTER", "RENEW", "TRANSFER", "REACTIVATE"]
           },
-          "tld": {
+          "ProductName": {
             "type": "string",
-            "description": "Top-level domain (e.g. 'com' from 'example.com')"
+            "description": "Specific product (e.g. for DOMAIN this is the TLD: 'com', 'net')"
           },
-          "nameservers": {
+          "ActionName": {
             "type": "string",
-            "description": "Comma-separated list of nameservers (e.g. 'ns1.example.com,ns2.example.com')"
+            "enum": ["REGISTER", "RENEW", "TRANSFER", "REACTIVATE"]
           }
         },
-        "required": [
-          "sld",
-          "tld",
-          "nameservers"
-        ]
+        "required": ["ProductType"]
       }
     }
   ]
-}
+}