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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
//! Create and access gift cards and link customers to gift cards.
//!
//! Square gift cards enable sellers to boost sales and attract new customers. Sellers can easily
//! sell, redeem, track, and reload Square gift cards.
//!
//! Developers can use the Gift Cards API to integrate Square gift cards into third-party
//! applications. In addition, developers can use the Gift Card Activities API to create gift card
//! activities, such as activate a gift card, add funds to a gift card, and redeem a gift card.
use crate::{
SquareClient,
config::Configuration,
http::client::HttpClient,
models::{
CreateGiftCardRequest, CreateGiftCardResponse, LinkCustomerToGiftCardRequest,
LinkCustomerToGiftCardResponse, ListGiftCardsParameters, ListGiftCardsResponse,
RetrieveGiftCardFromGANRequest, RetrieveGiftCardFromGANResponse,
RetrieveGiftCardFromNonceRequest, RetrieveGiftCardFromNonceResponse,
RetrieveGiftCardResponse, UnlinkCustomerFromGiftCardRequest,
UnlinkCustomerFromGiftCardResponse, errors::SquareApiError,
},
};
const DEFAULT_URI: &str = "/gift-cards";
pub struct GiftCardsApi {
/// App config information
config: Configuration,
/// HTTP Client for requests to the Gift Cards API endpoints
http_client: HttpClient,
}
impl GiftCardsApi {
/// Instantiates a new `GiftCardsApi`
pub fn new(square_client: SquareClient) -> GiftCardsApi {
GiftCardsApi {
config: square_client.config,
http_client: square_client.http_client,
}
}
/// Lists all gift cards.
///
/// You can specify optional filters to retrieve a subset of the gift cards. Results are sorted
/// by created_at in ascending order.
pub async fn list_gift_cards(
&self,
params: &ListGiftCardsParameters,
) -> Result<ListGiftCardsResponse, SquareApiError> {
let url = format!("{}{}", &self.url(), params.to_query_string());
let response = self.http_client.get(&url).await?;
response.deserialize().await
}
/// Creates a digital gift card or registers a physical (plastic) gift card.
///
/// After the gift card is created, you must call
/// [CreateGiftCardActivity](https://developer.squareup.com/reference/square/giftcardactivities-api/create-gift-card-activity)
/// to activate the card with an initial balance before it can be used for payment.
pub async fn create_gift_card(
&self,
body: &CreateGiftCardRequest,
) -> Result<CreateGiftCardResponse, SquareApiError> {
let response = self.http_client.post(&self.url(), body).await?;
response.deserialize().await
}
/// Retrieves a gift card using the gift card account number (GAN).
pub async fn retrieve_gift_card_from_gan(
&self,
body: &RetrieveGiftCardFromGANRequest,
) -> Result<RetrieveGiftCardFromGANResponse, SquareApiError> {
let url = format!("{}/from-gan", &self.url());
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Retrieves a gift card using a secure payment token that represents the gift card.
pub async fn retrieve_gift_card_from_nonce(
&self,
body: &RetrieveGiftCardFromNonceRequest,
) -> Result<RetrieveGiftCardFromNonceResponse, SquareApiError> {
let url = format!("{}/from-nonce", &self.url());
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Links a customer to a gift card, which is also referred to as adding a card on file.
///
/// `gift_card_id`: The ID of the gift card to be linked.
pub async fn link_customer_to_gift_card(
&self,
gift_card_id: impl AsRef<str>,
body: &LinkCustomerToGiftCardRequest,
) -> Result<LinkCustomerToGiftCardResponse, SquareApiError> {
let url = format!("{}/{}/link-customer", &self.url(), gift_card_id.as_ref());
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Unlinks a customer from a gift card, which is also referred to as removing a card on file.
///
/// `gift_card_id`: The ID of the gift card to be linked.
pub async fn unlink_customer_from_gift_card(
&self,
gift_card_id: impl AsRef<str>,
body: &UnlinkCustomerFromGiftCardRequest,
) -> Result<UnlinkCustomerFromGiftCardResponse, SquareApiError> {
let url = format!("{}/{}/unlink-customer", &self.url(), gift_card_id.as_ref());
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Retrieves a gift card using the gift card ID.
///
/// `id`: The ID of the gift card to retrieve.
pub async fn retrieve_gift_card(
&self,
id: impl AsRef<str>,
) -> Result<RetrieveGiftCardResponse, SquareApiError> {
let url = format!("{}/{}", &self.url(), 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)
}
}