Struct ramp_api::Ramp

pub struct Ramp { /* fields omitted */ }

Entrypoint for interacting with the Ramp API.

Implementations

impl Ramp

pub fn new<I, K, R, T, Q>(
    client_id: I,
    client_secret: K,
    redirect_uri: R,
    token: T,
    refresh_token: Q
) -> Self where
    I: ToString,
    K: ToString,
    R: ToString,
    T: ToString,
    Q: ToString, 

Create a new Ramp 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 client ID and secret your requests will work.

pub fn new_from_env<T, R>(token: T, refresh_token: R) -> Self where
    T: ToString,
    R: ToString, 

Create a new Ramp 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 your requests will work. We pass in the token and refresh token to the client so if you are storing it in a database, you can get it first.

pub async fn get_transactions(&self) -> Result<Vec<Transaction>, APIError>

Get all the transactions in the account.

pub fn user_consent_url(&self) -> String

pub async fn refresh_access_token(&mut self) -> Result<AccessToken, APIError>

pub async fn get_access_token(
    &mut self,
    code: &str,
    state: &str
) -> Result<AccessToken, APIError>

pub async fn list_reimbursements(&self) -> Result<Vec<Reimbursement>, APIError>

List all the reimbursements.

pub async fn list_departments(&self) -> Result<Vec<Department>, APIError>

List all the departments.

pub async fn list_users(&self) -> Result<Vec<User>, APIError>

List all the users.

pub async fn invite_new_user(&self, user: &User) -> Result<User, APIError>

Invite a new user.

pub async fn update_user(
    &self,
    id: &str,
    user: &UpdateUser
) -> Result<(), APIError>

Update a user.

pub async fn get_deferred_card_status(
    &self,
    card_id: &str
) -> Result<CardStatus, APIError>

Get the status of a deferred card.

pub async fn create_virtual_card(
    &self,
    card: &VirtualCard
) -> Result<DeferredCard, APIError>

Create a virtual card.

pub async fn create_physical_card(
    &self,
    card: &PhysicalCard
) -> Result<DeferredCard, APIError>

Create a physical card.

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

Get a user.

pub async fn list_cards_for_user(
    &self,
    user_id: &str
) -> Result<Vec<Card>, APIError>

List cards for a user.

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

Get a receipt.