Class: Verizon::DeviceFilterWithoutAccount

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

Overview

Filter for devices without account.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(group_name = SKIP, service_plan = SKIP, custom_fields = SKIP) ⇒ DeviceFilterWithoutAccount

Returns a new instance of DeviceFilterWithoutAccount.



48
49
50
51
52
 
# File 'lib/verizon/models/device_filter_without_account.rb', line 48

def initialize(group_name = SKIP, service_plan = SKIP, custom_fields = SKIP)
  @group_name = group_name unless group_name == SKIP
  @service_plan = service_plan unless service_plan == SKIP
  @custom_fields = custom_fields unless custom_fields == SKIP
end

Instance Attribute Details

#custom_fields ⇒ Array[CustomFields]

Custom field names and values, if you want to only include devices that have matching values.

Returns:



23
24
25
 
# File 'lib/verizon/models/device_filter_without_account.rb', line 23

def custom_fields
  @custom_fields
end

#group_name ⇒ String

Only include devices that are in this device group.

Returns:

  • (String) 


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

def group_name
  @group_name
end

#service_plan ⇒ String

Only include devices that have this service plan.

Returns:

  • (String) 


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

def service_plan
  @service_plan
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/verizon/models/device_filter_without_account.rb', line 55

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
  service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
  # Parameter is an array, so we need to iterate through it
  custom_fields = nil
  unless hash['customFields'].nil?
    custom_fields = []
    hash['customFields'].each do |structure|
      custom_fields << (CustomFields.from_hash(structure) if structure)
    end
  end

  custom_fields = SKIP unless hash.key?('customFields')

  # Create object from extracted values.
  DeviceFilterWithoutAccount.new(group_name,
                                 service_plan,
                                 custom_fields)
end

.names ⇒ Object

A mapping from model property names to API property names.



26
27
28
29
30
31
32
 
# File 'lib/verizon/models/device_filter_without_account.rb', line 26

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['group_name'] = 'groupName'
  @_hash['service_plan'] = 'servicePlan'
  @_hash['custom_fields'] = 'customFields'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



44
45
46
 
# File 'lib/verizon/models/device_filter_without_account.rb', line 44

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



35
36
37
38
39
40
41
 
# File 'lib/verizon/models/device_filter_without_account.rb', line 35

def self.optionals
  %w[
    group_name
    service_plan
    custom_fields
  ]
end