Struct checkr::Checkr

pub struct Checkr { /* fields omitted */ }

Entrypoint for interacting with the Checker API.

Implementations

impl Checkr

pub fn new<K>(key: K) -> Self where
    K: ToString, 

Create a new Checker client struct. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API key your requests will work.

pub fn new_from_env() -> Self

Create a new Checker client struct from environment variables. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API key and domain and your requests will work.

pub async fn list_candidates(&self) -> Result<Vec<Candidate>, APIError>

List candidates.

pub async fn get_candidate(&self, id: &str) -> Result<Candidate, APIError>

Get a candidate.

pub async fn create_candidate(&self, email: &str) -> Result<Candidate, APIError>

Create a new candidate.

pub async fn get_report(&self, id: &str) -> Result<Report, APIError>

Get a report.

pub async fn list_invitations(&self) -> Result<Vec<Invitation>, APIError>

List invitations.

pub async fn create_invitation(
    &self,
    candidate_id: &str,
    package: &str
) -> Result<Invitation, APIError>

Create a new invitation.