« blib/lib/Paws/Pinpoint/NumberValidateRequest.pm
↑ Summary
blib/lib/Paws/Pinpoint/PhoneNumberValidate.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::NumberValidateResponse; | ||
| 3 | use Moose; | ||
| 4 | has Carrier => (is => 'ro', isa => 'Str'); | ||
| 5 | has City => (is => 'ro', isa => 'Str'); | ||
| 6 | has CleansedPhoneNumberE164 => (is => 'ro', isa => 'Str'); | ||
| 7 | has CleansedPhoneNumberNational => (is => 'ro', isa => 'Str'); | ||
| 8 | has Country => (is => 'ro', isa => 'Str'); | ||
| 9 | has CountryCodeIso2 => (is => 'ro', isa => 'Str'); | ||
| 10 | has CountryCodeNumeric => (is => 'ro', isa => 'Str'); | ||
| 11 | has County => (is => 'ro', isa => 'Str'); | ||
| 12 | has OriginalCountryCodeIso2 => (is => 'ro', isa => 'Str'); | ||
| 13 | has OriginalPhoneNumber => (is => 'ro', isa => 'Str'); | ||
| 14 | has PhoneType => (is => 'ro', isa => 'Str'); | ||
| 15 | has PhoneTypeCode => (is => 'ro', isa => 'Int'); | ||
| 16 | has Timezone => (is => 'ro', isa => 'Str'); | ||
| 17 | has ZipCode => (is => 'ro', isa => 'Str'); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Pinpoint::NumberValidateResponse | ||
| 26 | |||
| 27 | =head1 USAGE | ||
| 28 | |||
| 29 | This class represents one of two things: | ||
| 30 | |||
| 31 | =head3 Arguments in a call to a service | ||
| 32 | |||
| 33 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 34 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 35 | |||
| 36 | As an example, if Att1 is expected to be a Paws::Pinpoint::NumberValidateResponse object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { Carrier => $value, ..., ZipCode => $value }); | ||
| 39 | |||
| 40 | =head3 Results returned from an API call | ||
| 41 | |||
| 42 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::NumberValidateResponse object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->Carrier | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | Provides information about a phone number. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Carrier => Str | ||
| 55 | |||
| 56 | The carrier or service provider that the phone number is currently | ||
| 57 | registered with. In some countries and regions, this value may be the | ||
| 58 | carrier or service provider that the phone number was originally | ||
| 59 | registered with. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 City => Str | ||
| 63 | |||
| 64 | The name of the city where the phone number was originally registered. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 CleansedPhoneNumberE164 => Str | ||
| 68 | |||
| 69 | The cleansed phone number, in E.164 format, for the location where the | ||
| 70 | phone number was originally registered. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 CleansedPhoneNumberNational => Str | ||
| 74 | |||
| 75 | The cleansed phone number, in the format for the location where the | ||
| 76 | phone number was originally registered. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 Country => Str | ||
| 80 | |||
| 81 | The name of the country or region where the phone number was originally | ||
| 82 | registered. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 CountryCodeIso2 => Str | ||
| 86 | |||
| 87 | The two-character code, in ISO 3166-1 alpha-2 format, for the country | ||
| 88 | or region where the phone number was originally registered. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 CountryCodeNumeric => Str | ||
| 92 | |||
| 93 | The numeric code for the country or region where the phone number was | ||
| 94 | originally registered. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 County => Str | ||
| 98 | |||
| 99 | The name of the county where the phone number was originally | ||
| 100 | registered. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 OriginalCountryCodeIso2 => Str | ||
| 104 | |||
| 105 | The two-character code, in ISO 3166-1 alpha-2 format, that was sent in | ||
| 106 | the request body. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 OriginalPhoneNumber => Str | ||
| 110 | |||
| 111 | The phone number that was sent in the request body. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 PhoneType => Str | ||
| 115 | |||
| 116 | The description of the phone type. Valid values are: MOBILE, LANDLINE, | ||
| 117 | VOIP, INVALID, PREPAID, and OTHER. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 PhoneTypeCode => Int | ||
| 121 | |||
| 122 | The phone type, represented by an integer. Valid values are: 0 | ||
| 123 | (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 | ||
| 124 | (prepaid). | ||
| 125 | |||
| 126 | |||
| 127 | =head2 Timezone => Str | ||
| 128 | |||
| 129 | The time zone for the location where the phone number was originally | ||
| 130 | registered. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 ZipCode => Str | ||
| 134 | |||
| 135 | The postal or ZIP code for the location where the phone number was | ||
| 136 | originally registered. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head1 SEE ALSO | ||
| 141 | |||
| 142 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 143 | |||
| 144 | =head1 BUGS and CONTRIBUTIONS | ||
| 145 | |||
| 146 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 147 | |||
| 148 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 149 | |||
| 150 | =cut | ||
| 151 |