class OpenapiClient::Items

Network information.

Attributes

bssid[RW]

The Wi-Fi networks Basic Service Set Identifier (BSSID).

carrier_name[RW]

The network carrier name.

cell_id[RW]

The Cell ID (CID) is identifier for a specific Base Transceiver Station (BTS) within a specific Location Area Code (LAC).

ip[RW]

The IPv4 or IPv6 address of the device if the network assigned one.

location_area_code[RW]

The Location Area Code (LAC) is a 16-bit identifier for a region that is covered by a set of network antennas.

mac[RW]

The MAC address of the device that is connected to the Wi-Fi network.

mobile_country_code[RW]

The Mobile Country Code (MCC) as described in the ITUs E.212 specification.

mobile_network_code[RW]

The Mobile Network Code (MNC) as described in the ITUs E.212 specification.

network_type[RW]

Defines the type of network associated with the device.

phone_number[RW]

The devices primary phone number. This value should be supplied directly without any transformation (e.g. removal of spaces, hyphens or parentheses). If this data is available in segregated fields, it should be concatenated using a blank space (" ") as a separator.

ssid[RW]

The Wi-Fi networks Service Set Identifier (SSID).

standard[RW]

An identifier of the network standard used.

subscription_identification_number[RW]

The Mobile Subscription Identification Number code (MSIN) as described in the ITUs E.212 specification.

user_defined[RW]

A JSON object that can carry any additional information about the network that might be helpful for fraud detection.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/openapi_client/models/items.rb, line 83
def self.attribute_map
  {
    :'network_type' => :'networkType',
    :'ip' => :'ip',
    :'phone_number' => :'phoneNumber',
    :'carrier_name' => :'carrierName',
    :'mobile_country_code' => :'mobileCountryCode',
    :'mobile_network_code' => :'mobileNetworkCode',
    :'subscription_identification_number' => :'subscriptionIdentificationNumber',
    :'location_area_code' => :'locationAreaCode',
    :'cell_id' => :'cellId',
    :'standard' => :'standard',
    :'mac' => :'mac',
    :'ssid' => :'ssid',
    :'bssid' => :'bssid',
    :'user_defined' => :'userDefined'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/openapi_client/models/items.rb, line 260
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/openapi_client/models/items.rb, line 124
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Items` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Items`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'network_type')
    self.network_type = attributes[:'network_type']
  end

  if attributes.key?(:'ip')
    self.ip = attributes[:'ip']
  end

  if attributes.key?(:'phone_number')
    self.phone_number = attributes[:'phone_number']
  end

  if attributes.key?(:'carrier_name')
    self.carrier_name = attributes[:'carrier_name']
  end

  if attributes.key?(:'mobile_country_code')
    self.mobile_country_code = attributes[:'mobile_country_code']
  end

  if attributes.key?(:'mobile_network_code')
    self.mobile_network_code = attributes[:'mobile_network_code']
  end

  if attributes.key?(:'subscription_identification_number')
    self.subscription_identification_number = attributes[:'subscription_identification_number']
  end

  if attributes.key?(:'location_area_code')
    self.location_area_code = attributes[:'location_area_code']
  end

  if attributes.key?(:'cell_id')
    self.cell_id = attributes[:'cell_id']
  end

  if attributes.key?(:'standard')
    self.standard = attributes[:'standard']
  end

  if attributes.key?(:'mac')
    self.mac = attributes[:'mac']
  end

  if attributes.key?(:'ssid')
    self.ssid = attributes[:'ssid']
  end

  if attributes.key?(:'bssid')
    self.bssid = attributes[:'bssid']
  end

  if attributes.key?(:'user_defined')
    self.user_defined = attributes[:'user_defined']
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/openapi_client/models/items.rb, line 103
def self.openapi_types
  {
    :'network_type' => :'String',
    :'ip' => :'String',
    :'phone_number' => :'String',
    :'carrier_name' => :'String',
    :'mobile_country_code' => :'String',
    :'mobile_network_code' => :'String',
    :'subscription_identification_number' => :'String',
    :'location_area_code' => :'String',
    :'cell_id' => :'String',
    :'standard' => :'String',
    :'mac' => :'String',
    :'ssid' => :'String',
    :'bssid' => :'String',
    :'user_defined' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/openapi_client/models/items.rb, line 226
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      network_type == o.network_type &&
      ip == o.ip &&
      phone_number == o.phone_number &&
      carrier_name == o.carrier_name &&
      mobile_country_code == o.mobile_country_code &&
      mobile_network_code == o.mobile_network_code &&
      subscription_identification_number == o.subscription_identification_number &&
      location_area_code == o.location_area_code &&
      cell_id == o.cell_id &&
      standard == o.standard &&
      mac == o.mac &&
      ssid == o.ssid &&
      bssid == o.bssid &&
      user_defined == o.user_defined
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/openapi_client/models/items.rb, line 288
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/openapi_client/models/items.rb, line 362
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/openapi_client/models/items.rb, line 267
def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/openapi_client/models/items.rb, line 247
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/openapi_client/models/items.rb, line 253
def hash
  [network_type, ip, phone_number, carrier_name, mobile_country_code, mobile_network_code, subscription_identification_number, location_area_code, cell_id, standard, mac, ssid, bssid, user_defined].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/openapi_client/models/items.rb, line 196
def list_invalid_properties
  invalid_properties = Array.new
  if @network_type.nil?
    invalid_properties.push('invalid value for "network_type", network_type cannot be nil.')
  end

  invalid_properties
end
network_type=(network_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] network_type Object to be assigned

# File lib/openapi_client/models/items.rb, line 216
def network_type=(network_type)
  validator = EnumAttributeValidator.new('String', ["network/mobile", "network/wifi"])
  unless validator.valid?(network_type)
    fail ArgumentError, "invalid value for \"network_type\", must be one of #{validator.allowable_values}."
  end
  @network_type = network_type
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/openapi_client/models/items.rb, line 338
def to_body
  to_hash
end
to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/openapi_client/models/items.rb, line 344
def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/openapi_client/models/items.rb, line 332
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/openapi_client/models/items.rb, line 207
def valid?
  return false if @network_type.nil?
  network_type_validator = EnumAttributeValidator.new('String', ["network/mobile", "network/wifi"])
  return false unless network_type_validator.valid?(@network_type)
  true
end