Struct Client 

pub struct Client { /* private fields */ }

An asynchronous client for the Namecheap API.

A Client bundles your API credentials, the whitelisted client IP, and the chosen Environment, and exposes the supported commands through grouped accessors: domains() and users().

The client is cheap to clone and is safe to share across tasks; it wraps a connection-pooling reqwest::Client internally.

Example

use namecheap_client::{Client, Environment};

let client = Client::builder()
    .api_user("your-api-user")
    .api_key("your-api-key")
    .client_ip("203.0.113.10") // your whitelisted public IPv4
    .environment(Environment::Sandbox)
    .build()?;

let balances = client.users().get_balances().await?;
println!("available: {} {}", balances.available_balance, balances.currency);

Implementations

impl Client

pub fn builder() -> ClientBuilder

Starts building a client. See ClientBuilder.

pub fn new( api_user: impl Into<String>, api_key: impl Into<String>, client_ip: impl Into<String>, ) -> Result<Self>

Creates a production client with the minimum required fields.

user_name defaults to api_user. To target the sandbox or to set a distinct username, use Client::builder instead.

Errors

Returns Error::Configuration if the underlying HTTP client cannot be constructed.

pub fn domains(&self) -> Domains<'_>

Commands in the namecheap.domains namespace.

pub fn users(&self) -> Users<'_>

Commands in the namecheap.users namespace.

pub fn environment(&self) -> Environment

The environment this client targets.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.