termii_rust/async_impl/rest/token/
mod.rs

1//! Send and verify OTP messages for quick logins.
2
3//! # Examples
4//!
5//! ## Fetch JSON In-App otp's.
6//!
7//! ```rust
8//! use termii_rust::{
9//!     async_impl::rest::termii,
10//!     common::token::{InAppTokenMessageType, InAppTokenRequest},
11//! };
12//!
13//! let client = termii::Termii::new("Your API key");
14//!
15//! let in_app_token_request =
16//!     InAppTokenRequest::new("+234XXXXXXXXXX", InAppTokenMessageType::NUMERIC, 3, 300, 6);
17//!
18//! let in_app_token_response = client
19//!     .token
20//!     .in_app_token
21//!     .send(in_app_token_request)
22//!     .await
23//!     .unwrap();
24//!
25//! println!("{:?}", in_app_token_response);
26//! ```
27//!
28//!
29//! ## Send a one time token request.
30//!
31//! ```rust
32//! use termii_rust::{
33//!     async_impl::rest::termii,
34//!     common::token::{
35//!         RequestTokenChannel, RequestTokenMessageType, RequestTokenPinType, RequestTokenRequest,
36//!     },
37//! };
38//!
39//! let client = termii::Termii::new("Your API key");
40//!
41//! let otp_request = RequestTokenRequest::new(
42//!     RequestTokenMessageType::ALPHANUMERIC,
43//!     String::from("234XXXXXXXXXX"),
44//!     String::from("Your org sender ID"),
45//!     RequestTokenChannel::Generic,
46//!     3 as u8,
47//!     50 as usize,
48//!     6 as u8,
49//!     String::from("< 1234 >"),
50//!     String::from("Your pin is < 1234 >"),
51//!     RequestTokenPinType::ALPHANUMERIC,
52//! );
53//!
54//! let response = client.token.request.send(otp_request).await.unwrap();
55//!
56//! println!("{:#?}", response);
57//! ```
58//!
59//!
60//! ## Verify one-time passwords and return responses.
61//!
62//! ```rust
63//! use termii_rust::{async_impl::rest::termii, common::token::VerifyTokenRequest};
64//!
65//! let client = termii::Termii::new("Your API key");
66//!
67//! let verify_otp_request = VerifyTokenRequest::new(
68//!     "c8dcd048-5e7f-4347-8c89-4470c3af0b".to_string(),
69//!     "195558".to_string(),
70//! );
71//!
72//! let response = client.token.verify.send(verify_otp_request).await.unwrap();
73//!
74//! println!("{:#?}", response);
75//! ```
76
77pub mod token;
78pub use token::*;
79
80pub mod request;
81pub use request::*;
82
83pub mod verify;
84pub use verify::*;
85
86pub mod in_app_token;
87pub use in_app_token::*;
termii_rust/async_impl/rest/token/mod.rs

termii_rust/async_impl/rest/token/
mod.rs
