Struct dnsimple::dnsimple::Client

pub struct Client {
    pub _agent: Agent,
    // some fields omitted
}

Represents the Rust client for the DNSimple API V2

The client is your entrypoint to the DNSimple API. Using it you will be able to call all the endpoints of the DNSimple API and their respective functions.

Examples

use dnsimple::dnsimple::{Client, new_client};

let client = new_client(true, String::from("AUTH_TOKEN"));
let identity = client.identity().whoami().unwrap().data.unwrap();

let account = identity.account.unwrap();

Fields

_agent: Agent

Implementations

impl Client

pub fn accounts(&self) -> Accounts<'_>

Returns the accounts service attached to this client

pub fn contacts(&self) -> Contacts<'_>

Returns the contacts service attached to this client

pub fn certificates(&self) -> Certificates<'_>

Returns the certificates service attached to this client

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

Returns the domains service attached to this client

pub fn identity(&self) -> Identity<'_>

Returns the identity service attached to this client

pub fn oauth(&self) -> OAuth<'_>

Returns the oauth service attached to this client

pub fn registrar(&self) -> Registrar<'_>

Returns the registrar service attached to this client

pub fn services(&self) -> Services<'_>

Returns the services service attached to this client

pub fn templates(&self) -> Templates<'_>

Returns the templates service attached to this client

pub fn tlds(&self) -> Tlds<'_>

Returns the tlds service attached to this endpoint

pub fn vanity_name_servers(&self) -> VanityNameServers<'_>

Returns the vanity_name_servers service attached to this endpoint

pub fn webhooks(&self) -> Webhooks<'_>

Returns the webhooks service attached to this endpoint

pub fn zones(&self) -> Zones<'_>

Returns the zones service attached to this endpoint

pub fn set_base_url(&mut self, url: &str)

Convenience function to change the base url in runtime (used internally for testing).

Note that if you want to do this you will have to declare your client mutable.

use dnsimple::dnsimple::{Client, new_client};
let mut client = new_client(true, String::from("ACCESS_TOKEN"));
client.set_base_url("https://example.com");

Arguments

url: The url we want to change the base url to.

pub fn versioned_url(&self) -> String

Returns the current url (including the API_VERSION as part of the path).

pub fn get<E: Endpoint>(
    &self,
    path: &str,
    options: Option<RequestOptions>
) -> Result<DNSimpleResponse<E::Output>, String>

Sends a GET request to the DNSimple API

Arguments

path: the path to the endpoint options: optionally a RequestOptions with things like pagination, filtering and sorting

pub fn post<E: Endpoint>(
    &self,
    path: &str,
    data: Value
) -> Result<DNSimpleResponse<E::Output>, String>

Sends a POST request to the DNSimple API

Arguments

path: the path to the endpoint data: the json payload to be sent to the server

pub fn empty_post(&self, path: &str) -> DNSimpleEmptyResponse

Sends a POST request to the DNSimple API without any payload

Arguments

path: the path to the endpoint

pub fn put<E: Endpoint>(
    &self,
    path: &str,
    data: Value
) -> Result<DNSimpleResponse<E::Output>, String>

Sends a PUT request to the DNSimple API

Arguments

path: the path to the endpoint data: the json payload to be sent to the server

pub fn empty_put(&self, path: &str) -> DNSimpleEmptyResponse

Sends a PUT request to the DNSimple API without any payload

Arguments

path: the path to the endpoint

pub fn patch<E: Endpoint>(
    &self,
    path: &str,
    data: Value
) -> Result<DNSimpleResponse<E::Output>, String>

Sends a PATCH request to the DNSimple API

Arguments

path: the path to the endpoint data: the json payload to be sent to the server

pub fn delete(&self, path: &str) -> DNSimpleEmptyResponse

Sends a DELETE request to the DNSimple API

Arguments

path: the path to the endpoint

pub fn delete_with_response<E: Endpoint>(
    &self,
    path: &str
) -> Result<DNSimpleResponse<E::Output>, String>

Sends a DELETE request to the DNSimple API returning a response containing a DNSimpleResponse

Arguments

path: the path to the endpoint

pub fn build_post_request(&self, path: &&str) -> Request

pub fn build_put_request(&self, path: &&str) -> Request

pub fn build_patch_request(&self, path: &&str) -> Request