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

//! Retrieve customer segments (also called smart groups) in a business account.
//!
//! The Customer Segments API lets you retrieve information about the segments defined for a
//! business. Square sellers can create customer segments in the Seller Dashboard or Point of Sale
//! by defining filters for the segment. For example, a segment can include customers who have
//! visited more than 10 times. Customers are automatically added to and removed from the segment
//! over time based on this criterion.
//!
//! You can inspect the customer's `segment_ids` property to determine which segments a customer
//! belongs to. Then, you can use the Customer Segments API to retrieve basic details about each
//! segment, such as the segment name and the time when it was created.

use crate::{
    SquareClient,
    config::Configuration,
    http::client::HttpClient,
    models::{
        ListCustomerSegmentsParameters, ListCustomerSegmentsResponse,
        RetrieveCustomerSegmentResponse, errors::SquareApiError,
    },
};

const DEFAULT_URI: &str = "/customers/segments";

/// Retrieve customer segments (also called smart groups) in a business account.
pub struct CustomerSegmentsApi {
    /// App config information
    config: Configuration,
    /// HTTP Client for requests to the Customer Segments API endpoints
    http_client: HttpClient,
}

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

    /// Retrieves the list of customer segments of a business.
    pub async fn list_customer_segments(
        &self,
        params: &ListCustomerSegmentsParameters,
    ) -> Result<ListCustomerSegmentsResponse, SquareApiError> {
        let url = format!("{}{}", &self.url(), params.to_query_string());
        let response = self.http_client.get(&url).await?;

        response.deserialize().await
    }

    /// Retrieves a specific customer segment as identified by the `segment_id` value.
    pub async fn retrieve_customer_segment(
        &self,
        segment_id: impl AsRef<str>,
    ) -> Result<RetrieveCustomerSegmentResponse, SquareApiError> {
        let url = format!("{}/{}", &self.url(), segment_id.as_ref());
        let response = self.http_client.get(&url).await?;

        response.deserialize().await
    }

    fn url(&self) -> String {
        format!("{}{}", &self.config.get_base_url(), DEFAULT_URI)
    }
}