|
| 1 | +/** |
| 2 | + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. |
| 3 | + * SPDX-License-Identifier: Apache-2.0. |
| 4 | + */ |
| 5 | + |
| 6 | +#pragma once |
| 7 | +#include <aws/core/utils/memory/stl/AWSString.h> |
| 8 | +#include <aws/pinpoint-sms-voice-v2/PinpointSMSVoiceV2_EXPORTS.h> |
| 9 | +#include <aws/pinpoint-sms-voice-v2/model/PhoneNumberType.h> |
| 10 | + |
| 11 | +#include <utility> |
| 12 | + |
| 13 | +namespace Aws { |
| 14 | +template <typename RESULT_TYPE> |
| 15 | +class AmazonWebServiceResult; |
| 16 | + |
| 17 | +namespace Utils { |
| 18 | +namespace Json { |
| 19 | +class JsonValue; |
| 20 | +} // namespace Json |
| 21 | +} // namespace Utils |
| 22 | +namespace PinpointSMSVoiceV2 { |
| 23 | +namespace Model { |
| 24 | +class CarrierLookupResult { |
| 25 | + public: |
| 26 | + AWS_PINPOINTSMSVOICEV2_API CarrierLookupResult() = default; |
| 27 | + AWS_PINPOINTSMSVOICEV2_API CarrierLookupResult(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result); |
| 28 | + AWS_PINPOINTSMSVOICEV2_API CarrierLookupResult& operator=(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result); |
| 29 | + |
| 30 | + ///@{ |
| 31 | + /** |
| 32 | + * <p>The phone number in E164 format, sanitized from the original input by |
| 33 | + * removing any formatting characters.</p> |
| 34 | + */ |
| 35 | + inline const Aws::String& GetE164PhoneNumber() const { return m_e164PhoneNumber; } |
| 36 | + template <typename E164PhoneNumberT = Aws::String> |
| 37 | + void SetE164PhoneNumber(E164PhoneNumberT&& value) { |
| 38 | + m_e164PhoneNumberHasBeenSet = true; |
| 39 | + m_e164PhoneNumber = std::forward<E164PhoneNumberT>(value); |
| 40 | + } |
| 41 | + template <typename E164PhoneNumberT = Aws::String> |
| 42 | + CarrierLookupResult& WithE164PhoneNumber(E164PhoneNumberT&& value) { |
| 43 | + SetE164PhoneNumber(std::forward<E164PhoneNumberT>(value)); |
| 44 | + return *this; |
| 45 | + } |
| 46 | + ///@} |
| 47 | + |
| 48 | + ///@{ |
| 49 | + /** |
| 50 | + * <p>The numeric dialing code for the country or region where the phone number was |
| 51 | + * originally registered.</p> |
| 52 | + */ |
| 53 | + inline const Aws::String& GetDialingCountryCode() const { return m_dialingCountryCode; } |
| 54 | + template <typename DialingCountryCodeT = Aws::String> |
| 55 | + void SetDialingCountryCode(DialingCountryCodeT&& value) { |
| 56 | + m_dialingCountryCodeHasBeenSet = true; |
| 57 | + m_dialingCountryCode = std::forward<DialingCountryCodeT>(value); |
| 58 | + } |
| 59 | + template <typename DialingCountryCodeT = Aws::String> |
| 60 | + CarrierLookupResult& WithDialingCountryCode(DialingCountryCodeT&& value) { |
| 61 | + SetDialingCountryCode(std::forward<DialingCountryCodeT>(value)); |
| 62 | + return *this; |
| 63 | + } |
| 64 | + ///@} |
| 65 | + |
| 66 | + ///@{ |
| 67 | + /** |
| 68 | + * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or |
| 69 | + * region where the phone number was originally registered.</p> |
| 70 | + */ |
| 71 | + inline const Aws::String& GetIsoCountryCode() const { return m_isoCountryCode; } |
| 72 | + template <typename IsoCountryCodeT = Aws::String> |
| 73 | + void SetIsoCountryCode(IsoCountryCodeT&& value) { |
| 74 | + m_isoCountryCodeHasBeenSet = true; |
| 75 | + m_isoCountryCode = std::forward<IsoCountryCodeT>(value); |
| 76 | + } |
| 77 | + template <typename IsoCountryCodeT = Aws::String> |
| 78 | + CarrierLookupResult& WithIsoCountryCode(IsoCountryCodeT&& value) { |
| 79 | + SetIsoCountryCode(std::forward<IsoCountryCodeT>(value)); |
| 80 | + return *this; |
| 81 | + } |
| 82 | + ///@} |
| 83 | + |
| 84 | + ///@{ |
| 85 | + /** |
| 86 | + * <p>The name of the country where the phone number was originally registered.</p> |
| 87 | + */ |
| 88 | + inline const Aws::String& GetCountry() const { return m_country; } |
| 89 | + template <typename CountryT = Aws::String> |
| 90 | + void SetCountry(CountryT&& value) { |
| 91 | + m_countryHasBeenSet = true; |
| 92 | + m_country = std::forward<CountryT>(value); |
| 93 | + } |
| 94 | + template <typename CountryT = Aws::String> |
| 95 | + CarrierLookupResult& WithCountry(CountryT&& value) { |
| 96 | + SetCountry(std::forward<CountryT>(value)); |
| 97 | + return *this; |
| 98 | + } |
| 99 | + ///@} |
| 100 | + |
| 101 | + ///@{ |
| 102 | + /** |
| 103 | + * <p>The phone number's mobile country code, for mobile phone number types</p> |
| 104 | + */ |
| 105 | + inline const Aws::String& GetMCC() const { return m_mCC; } |
| 106 | + template <typename MCCT = Aws::String> |
| 107 | + void SetMCC(MCCT&& value) { |
| 108 | + m_mCCHasBeenSet = true; |
| 109 | + m_mCC = std::forward<MCCT>(value); |
| 110 | + } |
| 111 | + template <typename MCCT = Aws::String> |
| 112 | + CarrierLookupResult& WithMCC(MCCT&& value) { |
| 113 | + SetMCC(std::forward<MCCT>(value)); |
| 114 | + return *this; |
| 115 | + } |
| 116 | + ///@} |
| 117 | + |
| 118 | + ///@{ |
| 119 | + /** |
| 120 | + * <p>The phone number's mobile network code, for mobile phone number types.</p> |
| 121 | + */ |
| 122 | + inline const Aws::String& GetMNC() const { return m_mNC; } |
| 123 | + template <typename MNCT = Aws::String> |
| 124 | + void SetMNC(MNCT&& value) { |
| 125 | + m_mNCHasBeenSet = true; |
| 126 | + m_mNC = std::forward<MNCT>(value); |
| 127 | + } |
| 128 | + template <typename MNCT = Aws::String> |
| 129 | + CarrierLookupResult& WithMNC(MNCT&& value) { |
| 130 | + SetMNC(std::forward<MNCT>(value)); |
| 131 | + return *this; |
| 132 | + } |
| 133 | + ///@} |
| 134 | + |
| 135 | + ///@{ |
| 136 | + /** |
| 137 | + * <p>The carrier or service provider that the phone number is currently registered |
| 138 | + * with. In some countries and regions, this value may be the carrier or service |
| 139 | + * provider that the phone number was originally registered with.</p> |
| 140 | + */ |
| 141 | + inline const Aws::String& GetCarrier() const { return m_carrier; } |
| 142 | + template <typename CarrierT = Aws::String> |
| 143 | + void SetCarrier(CarrierT&& value) { |
| 144 | + m_carrierHasBeenSet = true; |
| 145 | + m_carrier = std::forward<CarrierT>(value); |
| 146 | + } |
| 147 | + template <typename CarrierT = Aws::String> |
| 148 | + CarrierLookupResult& WithCarrier(CarrierT&& value) { |
| 149 | + SetCarrier(std::forward<CarrierT>(value)); |
| 150 | + return *this; |
| 151 | + } |
| 152 | + ///@} |
| 153 | + |
| 154 | + ///@{ |
| 155 | + /** |
| 156 | + * <p>Describes the type of phone number. Valid values are: MOBILE, LANDLINE, |
| 157 | + * OTHER, and INVALID. Avoid sending SMS or voice messages to INVALID phone |
| 158 | + * numbers, as these numbers are unlikely to belong to actual recipients.</p> |
| 159 | + */ |
| 160 | + inline PhoneNumberType GetPhoneNumberType() const { return m_phoneNumberType; } |
| 161 | + inline void SetPhoneNumberType(PhoneNumberType value) { |
| 162 | + m_phoneNumberTypeHasBeenSet = true; |
| 163 | + m_phoneNumberType = value; |
| 164 | + } |
| 165 | + inline CarrierLookupResult& WithPhoneNumberType(PhoneNumberType value) { |
| 166 | + SetPhoneNumberType(value); |
| 167 | + return *this; |
| 168 | + } |
| 169 | + ///@} |
| 170 | + |
| 171 | + ///@{ |
| 172 | + |
| 173 | + inline const Aws::String& GetRequestId() const { return m_requestId; } |
| 174 | + template <typename RequestIdT = Aws::String> |
| 175 | + void SetRequestId(RequestIdT&& value) { |
| 176 | + m_requestIdHasBeenSet = true; |
| 177 | + m_requestId = std::forward<RequestIdT>(value); |
| 178 | + } |
| 179 | + template <typename RequestIdT = Aws::String> |
| 180 | + CarrierLookupResult& WithRequestId(RequestIdT&& value) { |
| 181 | + SetRequestId(std::forward<RequestIdT>(value)); |
| 182 | + return *this; |
| 183 | + } |
| 184 | + ///@} |
| 185 | + private: |
| 186 | + Aws::String m_e164PhoneNumber; |
| 187 | + bool m_e164PhoneNumberHasBeenSet = false; |
| 188 | + |
| 189 | + Aws::String m_dialingCountryCode; |
| 190 | + bool m_dialingCountryCodeHasBeenSet = false; |
| 191 | + |
| 192 | + Aws::String m_isoCountryCode; |
| 193 | + bool m_isoCountryCodeHasBeenSet = false; |
| 194 | + |
| 195 | + Aws::String m_country; |
| 196 | + bool m_countryHasBeenSet = false; |
| 197 | + |
| 198 | + Aws::String m_mCC; |
| 199 | + bool m_mCCHasBeenSet = false; |
| 200 | + |
| 201 | + Aws::String m_mNC; |
| 202 | + bool m_mNCHasBeenSet = false; |
| 203 | + |
| 204 | + Aws::String m_carrier; |
| 205 | + bool m_carrierHasBeenSet = false; |
| 206 | + |
| 207 | + PhoneNumberType m_phoneNumberType{PhoneNumberType::NOT_SET}; |
| 208 | + bool m_phoneNumberTypeHasBeenSet = false; |
| 209 | + |
| 210 | + Aws::String m_requestId; |
| 211 | + bool m_requestIdHasBeenSet = false; |
| 212 | +}; |
| 213 | + |
| 214 | +} // namespace Model |
| 215 | +} // namespace PinpointSMSVoiceV2 |
| 216 | +} // namespace Aws |
0 commit comments