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

//! Model struct for Address type

use serde::{Deserialize, Serialize};

use super::enums::Country;

/// Represents a postal address in a country.
///
/// For more information, see [Working with
/// Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct Address {
    /// The first line of the address.
    ///
    /// Fields that start with `address_line` provide the address's most specific details, like
    /// street number, street name, and building name. They do not provide less specific details
    /// like city, state/province, or country (these details are provided in other fields).
    pub address_line_1: Option<String>,
    /// The second line of the address, if any.
    pub address_line_2: Option<String>,
    /// The third line of the address, if any.
    pub address_line_3: Option<String>,
    /// The city or town of the address. For a full list of field meanings by country, see [Working
    /// with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
    pub locality: Option<String>,
    /// A civil region within the address's `locality`, if any.
    pub sublocality: Option<String>,
    /// A civil entity within the address's country. In the US, this is the state. For a full list
    /// of field meanings by country, see [Working with
    /// Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
    pub administrative_district_level_1: Option<String>,
    /// The address's postal code. For a full list of field meanings by country, see [Working with
    /// Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
    pub postal_code: Option<String>,
    /// The address's country, in the two-letter format of ISO 3166. For example, `US` or `FR`.
    pub country: Option<Country>,
}