summaryrefslogtreecommitdiff
path: root/include/tgbot/types/ShippingAddress.h
blob: 02feadddd76bde6d3dbb7507b2f5c62deea71dd9 (plain)
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
#ifndef TGBOT_SHIPPINGADDRESS_H
#define TGBOT_SHIPPINGADDRESS_H

#include <memory>
#include <string>

namespace TgBot {

/**
 * @brief This object represents a shipping address.
 *
 * @ingroup types
 */
class ShippingAddress {

public:
    typedef std::shared_ptr<ShippingAddress> Ptr;

    /**
     * @brief Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code
     */
    std::string countryCode;

    /**
     * @brief State, if applicable
     */
    std::string state;

    /**
     * @brief City
     */
    std::string city;

    /**
     * @brief First line for the address
     */
    std::string streetLine1;

    /**
     * @brief Second line for the address
     */
    std::string streetLine2;

    /**
     * @brief Address post code
     */
    std::string postCode;
};
}

#endif //TGBOT_SHIPPINGADDRESS_H