Class: Aws::Pinpoint::Types::NumberValidateResponse

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::NumberValidateResponse

Defined in:

gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Provides information about a phone number.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #carrier ⇒ String

  The carrier or service provider that the phone number is currently registered with.

• #city ⇒ String

  The name of the city where the phone number was originally registered.

• #cleansed_phone_number_e164 ⇒ String

  The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

• #cleansed_phone_number_national ⇒ String

  The cleansed phone number, in the format for the location where the phone number was originally registered.

• #country ⇒ String

  The name of the country or region where the phone number was originally registered.

• #country_code_iso_2 ⇒ String

  The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

• #country_code_numeric ⇒ String

  The numeric code for the country or region where the phone number was originally registered.

• #county ⇒ String

  The name of the county where the phone number was originally registered.

• #original_country_code_iso_2 ⇒ String

  The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

• #original_phone_number ⇒ String

  The phone number that was sent in the request body.

• #phone_type ⇒ String

  The description of the phone type.

• #phone_type_code ⇒ Integer

  The phone type, represented by an integer.

• #timezone ⇒ String

  The time zone for the location where the phone number was originally registered.

• #zip_code ⇒ String

  The postal or ZIP code for the location where the phone number was originally registered.

Instance Attribute Details

#carrier ⇒ String

The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#city ⇒ String

The name of the city where the phone number was originally registered.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#cleansed_phone_number_e164 ⇒ String

The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#cleansed_phone_number_national ⇒ String

The cleansed phone number, in the format for the location where the phone number was originally registered.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#country ⇒ String

The name of the country or region where the phone number was originally registered.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#country_code_iso_2 ⇒ String

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#country_code_numeric ⇒ String

The numeric code for the country or region where the phone number was originally registered.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#county ⇒ String

The name of the county where the phone number was originally registered.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#original_country_code_iso_2 ⇒ String

The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#original_phone_number ⇒ String

The phone number that was sent in the request body.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#phone_type ⇒ String

The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#phone_type_code ⇒ Integer

The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#timezone ⇒ String

The time zone for the location where the phone number was originally registered.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#zip_code ⇒ String

The postal or ZIP code for the location where the phone number was originally registered.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9273

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end