squareup 2.13.0

Rust SDK for the Square Developer API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

//! Use the Cards API to save a credit or debit card on file.
//!
//! You can use the CreateCard endpoint to save a credit or debit card to a Square account.
//! Developers can integrate the Cards API in their application to let Square sellers:
//!
//! * Save a card that can be charged by any Square seller who uses your application. Your
//!   application specifies the organization access token in the `CreateCard` request.
//! * Save a card that can be charged by a single Square seller. Your application specifies the
//!   access token of the specific seller account in the `CreateCard` request.
//!
//! The Cards API also supports other endpoints to manage the cards.

use crate::{
    SquareClient,
    config::Configuration,
    http::client::HttpClient,
    models::{
        CreateCardRequest, CreateCardResponse, DisableCardResponse, ListCardsParameters,
        ListCardsResponse, RetrieveCardResponse, errors::SquareApiError,
    },
};

const DEFAULT_URI: &str = "/cards";

/// Use the Cards API to save a credit or debit card on file.
pub struct CardsApi {
    /// App config information
    config: Configuration,
    /// HTTP Client for requests to the Cards API endpoints
    http_client: HttpClient,
}

impl CardsApi {
    /// Instantiates a new `CardsApi`
    pub fn new(square_client: SquareClient) -> CardsApi {
        CardsApi {
            config: square_client.config,
            http_client: square_client.http_client,
        }
    }

    /// Adds a card on file to an existing merchant.
    pub async fn create_card(
        &self,
        body: &CreateCardRequest,
    ) -> Result<CreateCardResponse, SquareApiError> {
        let response = self.http_client.post(&self.url(), body).await?;

        response.deserialize().await
    }

    /// Disables the card, preventing any further updates or charges.
    ///
    /// Disabling an already disabled card is allowed but has no effect.
    pub async fn disable_card(
        &self,
        card_id: impl AsRef<str>,
    ) -> Result<DisableCardResponse, SquareApiError> {
        let url = format!("{}/{}/disable", &self.url(), card_id.as_ref());
        let response = self.http_client.empty_post(&url).await?;

        response.deserialize().await
    }

    /// Retrieves a list of cards owned by the account making the request.
    ///
    /// A max of 25 cards will be returned.
    pub async fn list_cards(
        &self,
        params: &ListCardsParameters,
    ) -> Result<ListCardsResponse, SquareApiError> {
        let url = format!("{}{}", &self.url(), params.to_query_string());
        let response = self.http_client.get(&url).await?;

        response.deserialize().await
    }

    /// Retrieves details for a specific Card.
    pub async fn retrieve_card(
        &self,
        card_id: impl AsRef<str>,
    ) -> Result<RetrieveCardResponse, SquareApiError> {
        let url = format!("{}/{}", &self.url(), card_id.as_ref());
        let response = self.http_client.get(&url).await?;

        response.deserialize().await
    }

    /// Constructs the basic entity URL including domain and entity path. Any additional path
    /// elements (e.g. path parameters) will need to be appended to this URL.
    fn url(&self) -> String {
        format!("{}{}", &self.config.get_base_url(), DEFAULT_URI)
    }
}