Struct ramp_api::Ramp

pub struct Ramp { /* fields omitted */ }

Entrypoint for interacting with the Ramp API.

Implementations

impl Ramp

pub async fn new<K, S>(client_id: K, client_secret: S) -> Self where
    K: ToString,
    S: 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 async fn new_from_env() -> Self

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 your requests will work.

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

Get all the transactions in the account.

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: &User) -> Result<User, APIError>

Update a user.

pub async fn create_physical_card(&self, card: &Card) -> Result<Card, 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.