Class: Verizon::DeviceIdSearch

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/verizon/models/device_id_search.rb

Overview

Search by device id.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(kind = nil, contains = SKIP, startswith = SKIP, endswith = SKIP) ⇒ DeviceIdSearch

Returns a new instance of DeviceIdSearch.



54
55
56
57
58
59
60
61
62
 
# File 'lib/verizon/models/device_id_search.rb', line 54

def initialize(kind = nil,
               contains = SKIP,
               startswith = SKIP,
               endswith = SKIP)
  @contains = contains unless contains == SKIP
  @startswith = startswith unless startswith == SKIP
  @endswith = endswith unless endswith == SKIP
  @kind = kind
end

Instance Attribute Details

#contains ⇒ String

The string appears anywhere in the identifer.

Returns:

  • (String) 


14
15
16
 
# File 'lib/verizon/models/device_id_search.rb', line 14

def contains
  @contains
end

#endswith ⇒ String

The identifier must end with the specified string.

Returns:

  • (String) 


22
23
24
 
# File 'lib/verizon/models/device_id_search.rb', line 22

def endswith
  @endswith
end

#kind ⇒ String

The type of the device identifier. Valid types of identifiers are:ESN (decimal),EID,ICCID (up to 20 digits),IMEI (up to 16 digits),MDN,MEID (hexadecimal),MSISDN.

Returns:

  • (String) 


28
29
30
 
# File 'lib/verizon/models/device_id_search.rb', line 28

def kind
  @kind
end

#startswith ⇒ String

The identifer must start with the specified string.

Returns:

  • (String) 


18
19
20
 
# File 'lib/verizon/models/device_id_search.rb', line 18

def startswith
  @startswith
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/verizon/models/device_id_search.rb', line 65

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  kind = hash.key?('kind') ? hash['kind'] : nil
  contains = hash.key?('contains') ? hash['contains'] : SKIP
  startswith = hash.key?('startswith') ? hash['startswith'] : SKIP
  endswith = hash.key?('endswith') ? hash['endswith'] : SKIP

  # Create object from extracted values.
  DeviceIdSearch.new(kind,
                     contains,
                     startswith,
                     endswith)
end

.names ⇒ Object

A mapping from model property names to API property names.



31
32
33
34
35
36
37
38
 
# File 'lib/verizon/models/device_id_search.rb', line 31

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['contains'] = 'contains'
  @_hash['startswith'] = 'startswith'
  @_hash['endswith'] = 'endswith'
  @_hash['kind'] = 'kind'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



50
51
52
 
# File 'lib/verizon/models/device_id_search.rb', line 50

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



41
42
43
44
45
46
47
 
# File 'lib/verizon/models/device_id_search.rb', line 41

def self.optionals
  %w[
    contains
    startswith
    endswith
  ]
end