Struct dnsimple::dnsimple::oauth::OAuth

source ·
pub struct OAuth<'a> {
    pub client: &'a Client,
}
Expand description

The Oauth Service is used to request access to the API

See API Documentation: oauth

Fields§

§client: &'a Client

Implementations§

source§

impl OAuth<'_>

source

pub fn exchange_authorization_for_token( &self, payload: OAuthTokenPayload ) -> Result<AccessToken, DNSimpleError>

Exchange the short-lived authorization code for an access token you can use to authenticate your API calls.

Examples
use dnsimple::dnsimple::new_client;
use dnsimple::dnsimple::oauth::OAuthTokenPayload;

let client = new_client(true, String::from("AUTH_TOKEN"));
let payload = OAuthTokenPayload {
    client_id: "id".to_string(),
    client_secret: "secret".to_string(),
    code: "code".to_string(),
    redirect_uri: "/redirect_uri".to_string(),
    state: "state".to_string()
};

let access_token = client.oauth().exchange_authorization_for_token(payload);
Attributes

payload: The OAuthTokenPayload with the necessary information to get the access token.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for OAuth<'a>

§

impl<'a> Send for OAuth<'a>

§

impl<'a> Sync for OAuth<'a>

§

impl<'a> Unpin for OAuth<'a>

§

impl<'a> !UnwindSafe for OAuth<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.