Struct ramp_api::cards::Cards

pub struct Cards {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Cards

pub async fn get_page(
    &self,
    start: &str,
    page_size: f64,
    user_id: &str,
    card_program_id: &str
) -> Result<Vec<Card>>

List cards.

This function performs a GET to the /cards endpoint.

Retrieve all cards.

Parameters:

• authorization: &str – The OAuth2 token header.
• start: &str – The ID of the last entity of the previous page, used for pagination to get the next page.
• page_size: f64 – The number of results to be returned in each page. The value must be between 2 and 10,000. If not specified, the default will be 1,000.
• user_id: &str – The OAuth2 token header.
• card_program_id: &str – The OAuth2 token header.

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

List cards.

This function performs a GET to the /cards endpoint.

As opposed to get, this function returns all the pages of the request at once.

Retrieve all cards.

pub async fn get(&self, id: &str) -> Result<Card>

GET a card.

This function performs a GET to the /cards/{id} endpoint.

Retrieve a single card.

Parameters:

• authorization: &str – The OAuth2 token header.

pub async fn patch_resources(
    &self,
    id: &str,
    body: &PatchResourcesCardsCardRequest
) -> Result<()>

Update card.

This function performs a PATCH to the /cards/{id} endpoint.

Update card details

Parameters:

• authorization: &str – The OAuth2 token header.

pub async fn post_resources_physical(
    &self,
    body: &PostResourcesCardPhysicalRequest
) -> Result<TaskResponse>

Create a physical card.

This function performs a POST to the /cards/deferred/physical endpoint.

Parameters:

• authorization: &str – The OAuth2 token header.

pub async fn post_resources_virtual(
    &self,
    body: &PostResourcesCardVirtualRequest
) -> Result<TaskResponse>

Create a virtual card.

This function performs a POST to the /cards/deferred/virtual endpoint.

Parameters:

• authorization: &str – The OAuth2 token header.

pub async fn post_resources_termination(
    &self,
    id: &str,
    body: &PostResourcesCardsCardSuspensionRequest
) -> Result<TaskResponse>

Delete a card.

This function performs a POST to the /cards/{id}/deferred/termination endpoint.

Terminates a card permanently.

pub async fn post_resources_suspension(
    &self,
    id: &str,
    body: &PostResourcesCardsCardSuspensionRequest
) -> Result<TaskResponse>

Suspend a card.

This function performs a POST to the /cards/{id}/deferred/suspension endpoint.

Suspends a card so that it is locked from use. The suspension is revertable.

pub async fn post_resources_unsuspension(
    &self,
    id: &str,
    body: &PostResourcesCardsCardSuspensionRequest
) -> Result<TaskResponse>

Removes a card’s suspension.

This function performs a POST to the /cards/{id}/deferred/unsuspension endpoint.

Removes a card’s suspension so that it may be used again.

pub async fn get_resources_deferred(
    &self,
    id: &str
) -> Result<GetResourcesCardsDeferredResponse>

Get status of a deferred card task.

This function performs a GET to the /cards/deferred/status/{id} endpoint.

Gets status of a deferred task for cards

Parameters:

• authorization: &str – The OAuth2 token header.